From 0486a42d42ea3dcc58ebfa22b4e926f1ddf6a58e Mon Sep 17 00:00:00 2001
From: Yoshi Automation Method Details
"model": "A String", # Full resource name of automl Model. Format: `projects/{project}/locations/{location}/models/{model}`.
"modelDisplayName": "A String", # The Model's display name in automl.googleapis.com.
},
- "dataLabelingDataset": { # Represents one Dataset in datalabeling.googleapis.com. # Output only. Represents one Dataset in datalabeling.googleapis.com.
+ "dataLabelingDataset": { # Represents one Dataset in datalabeling.googleapis.com. # Output only. Deprecated: Data Labeling Dataset migration is no longer supported. Represents one Dataset in datalabeling.googleapis.com.
"dataLabelingAnnotatedDatasets": [ # The migratable AnnotatedDataset in datalabeling.googleapis.com belongs to the data labeling Dataset.
{ # Represents one AnnotatedDataset in datalabeling.googleapis.com.
"annotatedDataset": "A String", # Full resource name of data labeling AnnotatedDataset. Format: `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html
index 428ffb4828..86d505d68a 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html
@@ -346,7 +346,7 @@ Method Details
"maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour).
},
"maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].
- "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10].
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 75].
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
"dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
{ # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
@@ -724,7 +724,7 @@ Method Details
"maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour).
},
"maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].
- "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10].
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 75].
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
"dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
{ # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
@@ -1033,7 +1033,7 @@ Method Details
"maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour).
},
"maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].
- "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10].
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 75].
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
"dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
{ # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
@@ -1312,7 +1312,7 @@ Method Details
"maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour).
},
"maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].
- "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10].
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 75].
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
"dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
{ # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html
index 0d51f330fb..6726ea4a86 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html
@@ -137,6 +137,9 @@ Method Details
"defaultContainerCategory": "A String", # Required. The category of the default container image.
},
"displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+ "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template.
+ "internetAccess": True or False, # Optional. Whether to allow internet access.
+ },
"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
"state": "A String", # Output only. The state of the sandbox environment template.
"updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
@@ -248,6 +251,9 @@ Method Details
"defaultContainerCategory": "A String", # Required. The category of the default container image.
},
"displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+ "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template.
+ "internetAccess": True or False, # Optional. Whether to allow internet access.
+ },
"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
"state": "A String", # Output only. The state of the sandbox environment template.
"updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
@@ -302,6 +308,9 @@ Method Details
"defaultContainerCategory": "A String", # Required. The category of the default container image.
},
"displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+ "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template.
+ "internetAccess": True or False, # Optional. Whether to allow internet access.
+ },
"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
"state": "A String", # Output only. The state of the sandbox environment template.
"updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironments.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironments.html
index 661329bf83..7cc12e2aea 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironments.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironments.html
@@ -122,13 +122,18 @@ Method Details
"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment.
"loadBalancerHostname": "A String", # Output only. The hostname of the load balancer.
"loadBalancerIp": "A String", # Output only. The IP address of the load balancer.
+ "routingToken": "A String", # Output only. The routing token for the SandboxEnvironment.
"sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment.
"sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment.
},
"createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created.
"displayName": "A String", # Required. The display name of the SandboxEnvironment.
"expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+ "latestSandboxEnvironmentSnapshot": "A String", # Output only. The resource name of the latest snapshot taken for this SandboxEnvironment.
"name": "A String", # Identifier. The name of the SandboxEnvironment.
+ "owner": "A String", # Optional. Owner information for this sandbox environment. A Sandbox can only be restored from a snapshot that belongs to the same owner. If not set, sandbox will be created as the default owner.
+ "sandboxEnvironmentSnapshot": "A String", # Optional. The resource name of the SandboxEnvironmentSnapshot to use for creating this SandboxEnvironment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+ "sandboxEnvironmentTemplate": "A String", # Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from. Only one of `sandbox_environment_template` and `spec` should be set.
"spec": { # The specification of a SandboxEnvironment. # Optional. The configuration of the SandboxEnvironment.
"codeExecutionEnvironment": { # The code execution environment with customized settings. # Optional. The code execution environment.
"codeLanguage": "A String", # The coding language supported in this environment.
@@ -268,13 +273,18 @@ Method Details
"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment.
"loadBalancerHostname": "A String", # Output only. The hostname of the load balancer.
"loadBalancerIp": "A String", # Output only. The IP address of the load balancer.
+ "routingToken": "A String", # Output only. The routing token for the SandboxEnvironment.
"sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment.
"sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment.
},
"createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created.
"displayName": "A String", # Required. The display name of the SandboxEnvironment.
"expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+ "latestSandboxEnvironmentSnapshot": "A String", # Output only. The resource name of the latest snapshot taken for this SandboxEnvironment.
"name": "A String", # Identifier. The name of the SandboxEnvironment.
+ "owner": "A String", # Optional. Owner information for this sandbox environment. A Sandbox can only be restored from a snapshot that belongs to the same owner. If not set, sandbox will be created as the default owner.
+ "sandboxEnvironmentSnapshot": "A String", # Optional. The resource name of the SandboxEnvironmentSnapshot to use for creating this SandboxEnvironment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+ "sandboxEnvironmentTemplate": "A String", # Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from. Only one of `sandbox_environment_template` and `spec` should be set.
"spec": { # The specification of a SandboxEnvironment. # Optional. The configuration of the SandboxEnvironment.
"codeExecutionEnvironment": { # The code execution environment with customized settings. # Optional. The code execution environment.
"codeLanguage": "A String", # The coding language supported in this environment.
@@ -311,13 +321,18 @@ Method Details
"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment.
"loadBalancerHostname": "A String", # Output only. The hostname of the load balancer.
"loadBalancerIp": "A String", # Output only. The IP address of the load balancer.
+ "routingToken": "A String", # Output only. The routing token for the SandboxEnvironment.
"sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment.
"sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment.
},
"createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created.
"displayName": "A String", # Required. The display name of the SandboxEnvironment.
"expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+ "latestSandboxEnvironmentSnapshot": "A String", # Output only. The resource name of the latest snapshot taken for this SandboxEnvironment.
"name": "A String", # Identifier. The name of the SandboxEnvironment.
+ "owner": "A String", # Optional. Owner information for this sandbox environment. A Sandbox can only be restored from a snapshot that belongs to the same owner. If not set, sandbox will be created as the default owner.
+ "sandboxEnvironmentSnapshot": "A String", # Optional. The resource name of the SandboxEnvironmentSnapshot to use for creating this SandboxEnvironment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+ "sandboxEnvironmentTemplate": "A String", # Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from. Only one of `sandbox_environment_template` and `spec` should be set.
"spec": { # The specification of a SandboxEnvironment. # Optional. The configuration of the SandboxEnvironment.
"codeExecutionEnvironment": { # The code execution environment with customized settings. # Optional. The code execution environment.
"codeLanguage": "A String", # The coding language supported in this environment.
diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.html b/docs/dyn/aiplatform_v1.reasoningEngines.html
index d529ae827f..1ce2519998 100644
--- a/docs/dyn/aiplatform_v1.reasoningEngines.html
+++ b/docs/dyn/aiplatform_v1.reasoningEngines.html
@@ -336,7 +336,7 @@ Method Details
"maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour).
},
"maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].
- "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10].
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 75].
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
"dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
{ # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
@@ -715,7 +715,7 @@ Method Details
"maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour).
},
"maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].
- "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10].
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 75].
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
"dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
{ # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
@@ -989,7 +989,7 @@ Method Details
"maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour).
},
"maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].
- "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10].
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 75].
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
"dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
{ # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
@@ -1268,7 +1268,7 @@ Method Details
"maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour).
},
"maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].
- "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10].
+ "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 75].
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
"dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
{ # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.html
index 95a5352a33..79fe316988 100644
--- a/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.html
+++ b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.html
@@ -137,6 +137,9 @@ Method Details
"defaultContainerCategory": "A String", # Required. The category of the default container image.
},
"displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+ "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template.
+ "internetAccess": True or False, # Optional. Whether to allow internet access.
+ },
"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
"state": "A String", # Output only. The state of the sandbox environment template.
"updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
@@ -248,6 +251,9 @@ Method Details
"defaultContainerCategory": "A String", # Required. The category of the default container image.
},
"displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+ "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template.
+ "internetAccess": True or False, # Optional. Whether to allow internet access.
+ },
"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
"state": "A String", # Output only. The state of the sandbox environment template.
"updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
@@ -302,6 +308,9 @@ Method Details
"defaultContainerCategory": "A String", # Required. The category of the default container image.
},
"displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+ "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template.
+ "internetAccess": True or False, # Optional. Whether to allow internet access.
+ },
"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
"state": "A String", # Output only. The state of the sandbox environment template.
"updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironments.html b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironments.html
index 55b8be9848..9fcba2089e 100644
--- a/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironments.html
+++ b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironments.html
@@ -122,13 +122,18 @@ Method Details
"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment.
"loadBalancerHostname": "A String", # Output only. The hostname of the load balancer.
"loadBalancerIp": "A String", # Output only. The IP address of the load balancer.
+ "routingToken": "A String", # Output only. The routing token for the SandboxEnvironment.
"sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment.
"sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment.
},
"createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created.
"displayName": "A String", # Required. The display name of the SandboxEnvironment.
"expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+ "latestSandboxEnvironmentSnapshot": "A String", # Output only. The resource name of the latest snapshot taken for this SandboxEnvironment.
"name": "A String", # Identifier. The name of the SandboxEnvironment.
+ "owner": "A String", # Optional. Owner information for this sandbox environment. A Sandbox can only be restored from a snapshot that belongs to the same owner. If not set, sandbox will be created as the default owner.
+ "sandboxEnvironmentSnapshot": "A String", # Optional. The resource name of the SandboxEnvironmentSnapshot to use for creating this SandboxEnvironment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+ "sandboxEnvironmentTemplate": "A String", # Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from. Only one of `sandbox_environment_template` and `spec` should be set.
"spec": { # The specification of a SandboxEnvironment. # Optional. The configuration of the SandboxEnvironment.
"codeExecutionEnvironment": { # The code execution environment with customized settings. # Optional. The code execution environment.
"codeLanguage": "A String", # The coding language supported in this environment.
@@ -268,13 +273,18 @@ Method Details
"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment.
"loadBalancerHostname": "A String", # Output only. The hostname of the load balancer.
"loadBalancerIp": "A String", # Output only. The IP address of the load balancer.
+ "routingToken": "A String", # Output only. The routing token for the SandboxEnvironment.
"sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment.
"sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment.
},
"createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created.
"displayName": "A String", # Required. The display name of the SandboxEnvironment.
"expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+ "latestSandboxEnvironmentSnapshot": "A String", # Output only. The resource name of the latest snapshot taken for this SandboxEnvironment.
"name": "A String", # Identifier. The name of the SandboxEnvironment.
+ "owner": "A String", # Optional. Owner information for this sandbox environment. A Sandbox can only be restored from a snapshot that belongs to the same owner. If not set, sandbox will be created as the default owner.
+ "sandboxEnvironmentSnapshot": "A String", # Optional. The resource name of the SandboxEnvironmentSnapshot to use for creating this SandboxEnvironment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+ "sandboxEnvironmentTemplate": "A String", # Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from. Only one of `sandbox_environment_template` and `spec` should be set.
"spec": { # The specification of a SandboxEnvironment. # Optional. The configuration of the SandboxEnvironment.
"codeExecutionEnvironment": { # The code execution environment with customized settings. # Optional. The code execution environment.
"codeLanguage": "A String", # The coding language supported in this environment.
@@ -311,13 +321,18 @@ Method Details
"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment.
"loadBalancerHostname": "A String", # Output only. The hostname of the load balancer.
"loadBalancerIp": "A String", # Output only. The IP address of the load balancer.
+ "routingToken": "A String", # Output only. The routing token for the SandboxEnvironment.
"sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment.
"sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment.
},
"createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created.
"displayName": "A String", # Required. The display name of the SandboxEnvironment.
"expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+ "latestSandboxEnvironmentSnapshot": "A String", # Output only. The resource name of the latest snapshot taken for this SandboxEnvironment.
"name": "A String", # Identifier. The name of the SandboxEnvironment.
+ "owner": "A String", # Optional. Owner information for this sandbox environment. A Sandbox can only be restored from a snapshot that belongs to the same owner. If not set, sandbox will be created as the default owner.
+ "sandboxEnvironmentSnapshot": "A String", # Optional. The resource name of the SandboxEnvironmentSnapshot to use for creating this SandboxEnvironment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+ "sandboxEnvironmentTemplate": "A String", # Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from. Only one of `sandbox_environment_template` and `spec` should be set.
"spec": { # The specification of a SandboxEnvironment. # Optional. The configuration of the SandboxEnvironment.
"codeExecutionEnvironment": { # The code execution environment with customized settings. # Optional. The code execution environment.
"codeLanguage": "A String", # The coding language supported in this environment.
diff --git a/docs/dyn/aiplatform_v1beta1.html b/docs/dyn/aiplatform_v1beta1.html
index 5e2600ea30..a1e1136028 100644
--- a/docs/dyn/aiplatform_v1beta1.html
+++ b/docs/dyn/aiplatform_v1beta1.html
@@ -289,6 +289,11 @@ Instance Methods
Returns the semanticGovernancePolicies Resource.
+
+ semanticGovernancePolicyEngine()
+
Returns the semanticGovernancePolicyEngine Resource.
+ diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index 15dca44461..4c52e64bc5 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -289,6 +289,11 @@Returns the semanticGovernancePolicies Resource.
+
+ semanticGovernancePolicyEngine()
+
Returns the semanticGovernancePolicyEngine Resource.
+ @@ -9097,6 +9102,7 @@
+ operations()
+
Returns the operations Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+ close()
Close httplib2 connections.
+ +Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+ +Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+ +Retrieves the next page of results.
+
+ wait(name, timeout=None, x__xgafv=None)
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+cancel(name, x__xgafv=None)
+ Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+close()
+ Close httplib2 connections.+
delete(name, x__xgafv=None)
+ Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+get(name, x__xgafv=None)
+ Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+ name: string, The name of the operation resource. (required)
+ x__xgafv: string, V1 error format.
+ 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.
+ },
+}
+list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+ Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation's parent resource. (required)
+ filter: string, The standard list filter.
+ pageSize: integer, The standard list page size.
+ pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "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.
+ },
+ },
+ ],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+ "A String",
+ ],
+}
+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. ++
wait(name, timeout=None, x__xgafv=None)
+ Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+ name: string, The name of the operation resource to wait on. (required)
+ timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+ 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.
+ },
+}
+
+ operations()
+
Returns the operations Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+ close()
Close httplib2 connections.
+ +Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+ +Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+ +Retrieves the next page of results.
+
+ wait(name, timeout=None, x__xgafv=None)
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+cancel(name, x__xgafv=None)
+ Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+close()
+ Close httplib2 connections.+
delete(name, x__xgafv=None)
+ Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+get(name, x__xgafv=None)
+ Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+ name: string, The name of the operation resource. (required)
+ x__xgafv: string, V1 error format.
+ 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.
+ },
+}
+list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+ Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation's parent resource. (required)
+ filter: string, The standard list filter.
+ pageSize: integer, The standard list page size.
+ pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "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.
+ },
+ },
+ ],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+ "A String",
+ ],
+}
+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. ++
wait(name, timeout=None, x__xgafv=None)
+ Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+ name: string, The name of the operation resource to wait on. (required)
+ timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+ 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.
+ },
+}
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, connectorConfigId=None, x__xgafv=None)
Creates a connector config.
+
+ delete(name, etag=None, x__xgafv=None)
Deletes a connector config.
+ +Gets a connector config with customer ID and config ID.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists connector configs of a customer.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
create(parent, body=None, connectorConfigId=None, x__xgafv=None)
+ Creates a connector config.
+
+Args:
+ parent: string, Required. Format: customers/{customer} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A representation of a connector config.
+ "details": { # The details of the connector config. LINT.IfChange # Required. The details of the connector config.
+ "crowdStrikeConfig": { # CrowdStrike connector config. # CrowdStrike connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the CrowdStrike config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "crowdStrikeFalconNextGenConfig": { # CrowdStrike Falcon Next Gen connector config. # CrowdStrike Falcon Next Gen connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the CrowdStrike Falcon Next Gen config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "crowdStrikeXdrConfig": { # CrowdStrike XDR connector config. # CrowdStrike XDR connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "xdrSettings": { # XDR settings for connector configs. # Required. The XDR settings for the CrowdStrike XDR config.
+ "enableAllXdrEvents": True or False, # Required. Whether to enable all XDR events.
+ },
+ },
+ "deviceTrustConfig": { # Device trust config for device trust connectors. # Device trust connector config.
+ "scope": "A String", # Required. The scope at which this configuration will be applied. Note that this only applies to Chrome browser, as in ChromeOS it's always applied.
+ "serviceAccounts": [ # Required. A list of email addresses of the service accounts which are allowed to call the Verified Access API with full access.
+ "A String",
+ ],
+ "serviceProvider": "A String", # Optional. The service provider for the device trust connector.
+ "urlMatchers": [ # Required. List of URLs allowed to be part of the attestation flow to get the set of signals from the machine. URLs must have HTTPS scheme, e.g. "https://example.com". Wildcards, *, are allowed. For detailed information on valid URL patterns, please see https://cloud.google.com/docs/chrome-enterprise/policies/url-patterns.
+ "A String",
+ ],
+ },
+ "googleSecOpsConfig": { # Google SecOps connector config. # Google SecOps connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host of ingestion API endpoint. Allows customer to upload events to servers in specific geographical regions. Existing configs that don't have this setting default to US.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Google SecOps config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "paloAltoNetworksConfig": { # Palo Alto Networks connector config. # Palo Alto Networks connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Palo Alto Networks config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "pubSubConfig": { # Pub/Sub connector config. # Pub/Sub connector config.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Pub/Sub config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ "topicFullPath": "A String", # Required. The full path to the topic to send the event to.
+ },
+ "pubSubXdrConfig": { # Pub/Sub XDR connector config. # Pub/Sub XDR connector config.
+ "topicFullPath": "A String", # Required. The full path to the topic to send the event to.
+ "xdrSettings": { # XDR settings for connector configs. # Required. The XDR settings for the Pub/Sub XDR config.
+ "enableAllXdrEvents": True or False, # Required. Whether to enable all XDR events.
+ },
+ },
+ "splunkConfig": { # Splunk connector config. # Splunk connector config.
+ "hecToken": "A String", # Required. Input only. The data input's HTTP Event Collector token to use as an Authorization header.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "portNumber": 42, # Optional. The port number to use. If not set, the default Splunk port is used.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Splunk config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ "source": "A String", # Optional. Optional source name to override the default one set in the Splunk admin console.
+ "unsecureScheme": True or False, # Optional. Whether to use an unsecure HTTP scheme. Defaults to false (HTTPS).
+ },
+ },
+ "displayName": "A String", # Required. The display name of the config.
+ "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "name": "A String", # Identifier. Format: customers/{customer}/connectorConfigs/{connector_config}
+ "status": { # The status of the connector config. # Output only. The status of the connector config.
+ "failureStartTime": "A String", # Output only. Field recording time of the earliest failure since the last success event. This field is only set when the state is `DISABLED_BY_FAILURES`.
+ "state": "A String", # Output only. The state of the connector config. The connector state is disabled if the connector has not successfully sent an event in the last 24 hours.
+ "updateTime": "A String", # Output only. Field recording time of most recent modification of the status. For ENABLED, this is the time the status was changed to ENABLED. For DISABLED_BY_FAILURES, this is the time of the most recent failed attempt to send an event to this config.
+ },
+ "type": "A String", # Required. The type of the connector.
+}
+
+ connectorConfigId: string, Optional. ID to use for the connector config, which becomes the final component of the connector config's resource name. If provided, the ID must be 1-63 characters long, and contain only lowercase letters, digits, and hyphens. It must start with a letter, and end with a letter or number. If not provided, the connector config will be assigned a random UUID.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A representation of a connector config.
+ "details": { # The details of the connector config. LINT.IfChange # Required. The details of the connector config.
+ "crowdStrikeConfig": { # CrowdStrike connector config. # CrowdStrike connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the CrowdStrike config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "crowdStrikeFalconNextGenConfig": { # CrowdStrike Falcon Next Gen connector config. # CrowdStrike Falcon Next Gen connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the CrowdStrike Falcon Next Gen config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "crowdStrikeXdrConfig": { # CrowdStrike XDR connector config. # CrowdStrike XDR connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "xdrSettings": { # XDR settings for connector configs. # Required. The XDR settings for the CrowdStrike XDR config.
+ "enableAllXdrEvents": True or False, # Required. Whether to enable all XDR events.
+ },
+ },
+ "deviceTrustConfig": { # Device trust config for device trust connectors. # Device trust connector config.
+ "scope": "A String", # Required. The scope at which this configuration will be applied. Note that this only applies to Chrome browser, as in ChromeOS it's always applied.
+ "serviceAccounts": [ # Required. A list of email addresses of the service accounts which are allowed to call the Verified Access API with full access.
+ "A String",
+ ],
+ "serviceProvider": "A String", # Optional. The service provider for the device trust connector.
+ "urlMatchers": [ # Required. List of URLs allowed to be part of the attestation flow to get the set of signals from the machine. URLs must have HTTPS scheme, e.g. "https://example.com". Wildcards, *, are allowed. For detailed information on valid URL patterns, please see https://cloud.google.com/docs/chrome-enterprise/policies/url-patterns.
+ "A String",
+ ],
+ },
+ "googleSecOpsConfig": { # Google SecOps connector config. # Google SecOps connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host of ingestion API endpoint. Allows customer to upload events to servers in specific geographical regions. Existing configs that don't have this setting default to US.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Google SecOps config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "paloAltoNetworksConfig": { # Palo Alto Networks connector config. # Palo Alto Networks connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Palo Alto Networks config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "pubSubConfig": { # Pub/Sub connector config. # Pub/Sub connector config.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Pub/Sub config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ "topicFullPath": "A String", # Required. The full path to the topic to send the event to.
+ },
+ "pubSubXdrConfig": { # Pub/Sub XDR connector config. # Pub/Sub XDR connector config.
+ "topicFullPath": "A String", # Required. The full path to the topic to send the event to.
+ "xdrSettings": { # XDR settings for connector configs. # Required. The XDR settings for the Pub/Sub XDR config.
+ "enableAllXdrEvents": True or False, # Required. Whether to enable all XDR events.
+ },
+ },
+ "splunkConfig": { # Splunk connector config. # Splunk connector config.
+ "hecToken": "A String", # Required. Input only. The data input's HTTP Event Collector token to use as an Authorization header.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "portNumber": 42, # Optional. The port number to use. If not set, the default Splunk port is used.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Splunk config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ "source": "A String", # Optional. Optional source name to override the default one set in the Splunk admin console.
+ "unsecureScheme": True or False, # Optional. Whether to use an unsecure HTTP scheme. Defaults to false (HTTPS).
+ },
+ },
+ "displayName": "A String", # Required. The display name of the config.
+ "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "name": "A String", # Identifier. Format: customers/{customer}/connectorConfigs/{connector_config}
+ "status": { # The status of the connector config. # Output only. The status of the connector config.
+ "failureStartTime": "A String", # Output only. Field recording time of the earliest failure since the last success event. This field is only set when the state is `DISABLED_BY_FAILURES`.
+ "state": "A String", # Output only. The state of the connector config. The connector state is disabled if the connector has not successfully sent an event in the last 24 hours.
+ "updateTime": "A String", # Output only. Field recording time of most recent modification of the status. For ENABLED, this is the time the status was changed to ENABLED. For DISABLED_BY_FAILURES, this is the time of the most recent failed attempt to send an event to this config.
+ },
+ "type": "A String", # Required. The type of the connector.
+}
+delete(name, etag=None, x__xgafv=None)
+ Deletes a connector config.
+
+Args:
+ name: string, Required. Format: customers/{customer}/connectorConfigs/{connector_config} (required)
+ etag: string, Optional. The etag of the connector config. If an etag is provided and does not match the current etag of the connector config, deletion will be blocked and an ABORTED error will be returned.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+get(name, x__xgafv=None)
+ Gets a connector config with customer ID and config ID.
+
+Args:
+ name: string, Required. Format: customers/{customer}/connectorConfigs/{connector_config} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A representation of a connector config.
+ "details": { # The details of the connector config. LINT.IfChange # Required. The details of the connector config.
+ "crowdStrikeConfig": { # CrowdStrike connector config. # CrowdStrike connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the CrowdStrike config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "crowdStrikeFalconNextGenConfig": { # CrowdStrike Falcon Next Gen connector config. # CrowdStrike Falcon Next Gen connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the CrowdStrike Falcon Next Gen config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "crowdStrikeXdrConfig": { # CrowdStrike XDR connector config. # CrowdStrike XDR connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "xdrSettings": { # XDR settings for connector configs. # Required. The XDR settings for the CrowdStrike XDR config.
+ "enableAllXdrEvents": True or False, # Required. Whether to enable all XDR events.
+ },
+ },
+ "deviceTrustConfig": { # Device trust config for device trust connectors. # Device trust connector config.
+ "scope": "A String", # Required. The scope at which this configuration will be applied. Note that this only applies to Chrome browser, as in ChromeOS it's always applied.
+ "serviceAccounts": [ # Required. A list of email addresses of the service accounts which are allowed to call the Verified Access API with full access.
+ "A String",
+ ],
+ "serviceProvider": "A String", # Optional. The service provider for the device trust connector.
+ "urlMatchers": [ # Required. List of URLs allowed to be part of the attestation flow to get the set of signals from the machine. URLs must have HTTPS scheme, e.g. "https://example.com". Wildcards, *, are allowed. For detailed information on valid URL patterns, please see https://cloud.google.com/docs/chrome-enterprise/policies/url-patterns.
+ "A String",
+ ],
+ },
+ "googleSecOpsConfig": { # Google SecOps connector config. # Google SecOps connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host of ingestion API endpoint. Allows customer to upload events to servers in specific geographical regions. Existing configs that don't have this setting default to US.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Google SecOps config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "paloAltoNetworksConfig": { # Palo Alto Networks connector config. # Palo Alto Networks connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Palo Alto Networks config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "pubSubConfig": { # Pub/Sub connector config. # Pub/Sub connector config.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Pub/Sub config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ "topicFullPath": "A String", # Required. The full path to the topic to send the event to.
+ },
+ "pubSubXdrConfig": { # Pub/Sub XDR connector config. # Pub/Sub XDR connector config.
+ "topicFullPath": "A String", # Required. The full path to the topic to send the event to.
+ "xdrSettings": { # XDR settings for connector configs. # Required. The XDR settings for the Pub/Sub XDR config.
+ "enableAllXdrEvents": True or False, # Required. Whether to enable all XDR events.
+ },
+ },
+ "splunkConfig": { # Splunk connector config. # Splunk connector config.
+ "hecToken": "A String", # Required. Input only. The data input's HTTP Event Collector token to use as an Authorization header.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "portNumber": 42, # Optional. The port number to use. If not set, the default Splunk port is used.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Splunk config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ "source": "A String", # Optional. Optional source name to override the default one set in the Splunk admin console.
+ "unsecureScheme": True or False, # Optional. Whether to use an unsecure HTTP scheme. Defaults to false (HTTPS).
+ },
+ },
+ "displayName": "A String", # Required. The display name of the config.
+ "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "name": "A String", # Identifier. Format: customers/{customer}/connectorConfigs/{connector_config}
+ "status": { # The status of the connector config. # Output only. The status of the connector config.
+ "failureStartTime": "A String", # Output only. Field recording time of the earliest failure since the last success event. This field is only set when the state is `DISABLED_BY_FAILURES`.
+ "state": "A String", # Output only. The state of the connector config. The connector state is disabled if the connector has not successfully sent an event in the last 24 hours.
+ "updateTime": "A String", # Output only. Field recording time of most recent modification of the status. For ENABLED, this is the time the status was changed to ENABLED. For DISABLED_BY_FAILURES, this is the time of the most recent failed attempt to send an event to this config.
+ },
+ "type": "A String", # Required. The type of the connector.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists connector configs of a customer.
+
+Args:
+ parent: string, Required. Format: customers/{customer} (required)
+ pageSize: integer, Optional. The maximum number of connector configs to return. The default page size is 50 if page_size is unspecified, and the maximum page size allowed is 100. Values above 100 will be capped at 100.
+ pageToken: string, Optional. A page token, received from a previous `ListConnectorConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectorConfigs` 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 to ListConnectorConfigs method.
+ "connectorConfigs": [ # The list of connector configs returned.
+ { # A representation of a connector config.
+ "details": { # The details of the connector config. LINT.IfChange # Required. The details of the connector config.
+ "crowdStrikeConfig": { # CrowdStrike connector config. # CrowdStrike connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the CrowdStrike config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "crowdStrikeFalconNextGenConfig": { # CrowdStrike Falcon Next Gen connector config. # CrowdStrike Falcon Next Gen connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the CrowdStrike Falcon Next Gen config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "crowdStrikeXdrConfig": { # CrowdStrike XDR connector config. # CrowdStrike XDR connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "xdrSettings": { # XDR settings for connector configs. # Required. The XDR settings for the CrowdStrike XDR config.
+ "enableAllXdrEvents": True or False, # Required. Whether to enable all XDR events.
+ },
+ },
+ "deviceTrustConfig": { # Device trust config for device trust connectors. # Device trust connector config.
+ "scope": "A String", # Required. The scope at which this configuration will be applied. Note that this only applies to Chrome browser, as in ChromeOS it's always applied.
+ "serviceAccounts": [ # Required. A list of email addresses of the service accounts which are allowed to call the Verified Access API with full access.
+ "A String",
+ ],
+ "serviceProvider": "A String", # Optional. The service provider for the device trust connector.
+ "urlMatchers": [ # Required. List of URLs allowed to be part of the attestation flow to get the set of signals from the machine. URLs must have HTTPS scheme, e.g. "https://example.com". Wildcards, *, are allowed. For detailed information on valid URL patterns, please see https://cloud.google.com/docs/chrome-enterprise/policies/url-patterns.
+ "A String",
+ ],
+ },
+ "googleSecOpsConfig": { # Google SecOps connector config. # Google SecOps connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host of ingestion API endpoint. Allows customer to upload events to servers in specific geographical regions. Existing configs that don't have this setting default to US.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Google SecOps config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "paloAltoNetworksConfig": { # Palo Alto Networks connector config. # Palo Alto Networks connector config.
+ "apiKey": "A String", # Required. Input only. API key to use on the ingestion API.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Palo Alto Networks config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ },
+ "pubSubConfig": { # Pub/Sub connector config. # Pub/Sub connector config.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Pub/Sub config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ "topicFullPath": "A String", # Required. The full path to the topic to send the event to.
+ },
+ "pubSubXdrConfig": { # Pub/Sub XDR connector config. # Pub/Sub XDR connector config.
+ "topicFullPath": "A String", # Required. The full path to the topic to send the event to.
+ "xdrSettings": { # XDR settings for connector configs. # Required. The XDR settings for the Pub/Sub XDR config.
+ "enableAllXdrEvents": True or False, # Required. Whether to enable all XDR events.
+ },
+ },
+ "splunkConfig": { # Splunk connector config. # Splunk connector config.
+ "hecToken": "A String", # Required. Input only. The data input's HTTP Event Collector token to use as an Authorization header.
+ "host": "A String", # Required. Host to identify the customer specific server to receive the events.
+ "portNumber": 42, # Optional. The port number to use. If not set, the default Splunk port is used.
+ "reportingSettings": { # Reporting settings for connector configs. # Required. The reporting settings for the Splunk config.
+ "enabledDefaultEvents": [ # Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.
+ "A String",
+ ],
+ "enabledDeviceEvents": [ # Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.
+ "A String",
+ ],
+ "enabledOptInEvents": [ # Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.
+ "A String",
+ ],
+ },
+ "source": "A String", # Optional. Optional source name to override the default one set in the Splunk admin console.
+ "unsecureScheme": True or False, # Optional. Whether to use an unsecure HTTP scheme. Defaults to false (HTTPS).
+ },
+ },
+ "displayName": "A String", # Required. The display name of the config.
+ "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "name": "A String", # Identifier. Format: customers/{customer}/connectorConfigs/{connector_config}
+ "status": { # The status of the connector config. # Output only. The status of the connector config.
+ "failureStartTime": "A String", # Output only. Field recording time of the earliest failure since the last success event. This field is only set when the state is `DISABLED_BY_FAILURES`.
+ "state": "A String", # Output only. The state of the connector config. The connector state is disabled if the connector has not successfully sent an event in the last 24 hours.
+ "updateTime": "A String", # Output only. Field recording time of most recent modification of the status. For ENABLED, this is the time the status was changed to ENABLED. For DISABLED_BY_FAILURES, this is the time of the most recent failed attempt to send an event to this config.
+ },
+ "type": "A String", # Required. The type of the connector.
+ },
+ ],
+ "nextPageToken": "A String", # The page token used to retrieve the next page of the listing request. If the token is empty, there are no more pages to retrieve.
+ "totalSize": 42, # The total size of the connector configs list.
+}
+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. ++
Returns the certificateProvisioningProcesses Resource.
+ +Returns the connectorConfigs Resource.
+ diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index 7830c7509d..586fb472e4 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -504,6 +504,122 @@ } } }, +"connectorConfigs": { +"methods": { +"create": { +"description": "Creates a connector config.", +"flatPath": "v1/customers/{customersId}/connectorConfigs", +"httpMethod": "POST", +"id": "chromemanagement.customers.connectorConfigs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"connectorConfigId": { +"description": "Optional. ID to use for the connector config, which becomes the final component of the connector config's resource name. If provided, the ID must be 1-63 characters long, and contain only lowercase letters, digits, and hyphens. It must start with a letter, and end with a letter or number. If not provided, the connector config will be assigned a random UUID.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Format: customers/{customer}", +"location": "path", +"pattern": "^customers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/connectorConfigs", +"request": { +"$ref": "GoogleChromeManagementVersionsV1ConnectorConfig" +}, +"response": { +"$ref": "GoogleChromeManagementVersionsV1ConnectorConfig" +} +}, +"delete": { +"description": "Deletes a connector config.", +"flatPath": "v1/customers/{customersId}/connectorConfigs/{connectorConfigsId}", +"httpMethod": "DELETE", +"id": "chromemanagement.customers.connectorConfigs.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "Optional. The etag of the connector config. If an etag is provided and does not match the current etag of the connector config, deletion will be blocked and an ABORTED error will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. Format: customers/{customer}/connectorConfigs/{connector_config}", +"location": "path", +"pattern": "^customers/[^/]+/connectorConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +} +}, +"get": { +"description": "Gets a connector config with customer ID and config ID.", +"flatPath": "v1/customers/{customersId}/connectorConfigs/{connectorConfigsId}", +"httpMethod": "GET", +"id": "chromemanagement.customers.connectorConfigs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: customers/{customer}/connectorConfigs/{connector_config}", +"location": "path", +"pattern": "^customers/[^/]+/connectorConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleChromeManagementVersionsV1ConnectorConfig" +} +}, +"list": { +"description": "Lists connector configs of a customer.", +"flatPath": "v1/customers/{customersId}/connectorConfigs", +"httpMethod": "GET", +"id": "chromemanagement.customers.connectorConfigs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of connector configs to return. The default page size is 50 if page_size is unspecified, and the maximum page size allowed is 100. Values above 100 will be capped at 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListConnectorConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectorConfigs` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Format: customers/{customer}", +"location": "path", +"pattern": "^customers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/connectorConfigs", +"response": { +"$ref": "GoogleChromeManagementVersionsV1ListConnectorConfigsResponse" +} +} +} +}, "profiles": { "methods": { "delete": { @@ -1786,7 +1902,7 @@ } } }, -"revision": "20260123", +"revision": "20260417", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -1830,6 +1946,14 @@ "readOnly": true, "type": "string" }, +"categoryIds": { +"description": "Output only. The category IDs of the app, which are the same as stored in the Web Store item. It's expected that there is only one category ID.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "chromeAppInfo": { "$ref": "GoogleChromeManagementV1ChromeAppInfo", "description": "Output only. Chrome Web Store app information.", @@ -6187,6 +6311,190 @@ false "properties": {}, "type": "object" }, +"GoogleChromeManagementVersionsV1ConnectorConfig": { +"description": "A representation of a connector config.", +"id": "GoogleChromeManagementVersionsV1ConnectorConfig", +"properties": { +"details": { +"$ref": "GoogleChromeManagementVersionsV1ConnectorConfigDetails", +"description": "Required. The details of the connector config." +}, +"displayName": { +"description": "Required. The display name of the config.", +"type": "string" +}, +"etag": { +"description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", +"type": "string" +}, +"name": { +"description": "Identifier. Format: customers/{customer}/connectorConfigs/{connector_config}", +"type": "string" +}, +"status": { +"$ref": "GoogleChromeManagementVersionsV1ConnectorConfigStatus", +"description": "Output only. The status of the connector config.", +"readOnly": true +}, +"type": { +"description": "Required. The type of the connector.", +"enum": [ +"CONNECTOR_TYPE_UNSPECIFIED", +"REPORTING", +"DEVICE_TRUST", +"XDR", +"IDENTITY_BASED_ENROLLMENT", +"CERTIFICATE_AUTHORITY", +"ROOT_STORE" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Reporting connector.", +"Device trust connector.", +"XDR connector.", +"Authentication connector.", +"Certificate authority connector. Not yet supported in the API.", +"Root certificate connector." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleChromeManagementVersionsV1ConnectorConfigDetails": { +"description": "The details of the connector config. LINT.IfChange", +"id": "GoogleChromeManagementVersionsV1ConnectorConfigDetails", +"properties": { +"crowdStrikeConfig": { +"$ref": "GoogleChromeManagementVersionsV1CrowdStrikeConfig", +"description": "CrowdStrike connector config." +}, +"crowdStrikeFalconNextGenConfig": { +"$ref": "GoogleChromeManagementVersionsV1CrowdStrikeFalconNextGenConfig", +"description": "CrowdStrike Falcon Next Gen connector config." +}, +"crowdStrikeXdrConfig": { +"$ref": "GoogleChromeManagementVersionsV1CrowdStrikeXdrConfig", +"description": "CrowdStrike XDR connector config." +}, +"deviceTrustConfig": { +"$ref": "GoogleChromeManagementVersionsV1DeviceTrustConfig", +"description": "Device trust connector config." +}, +"googleSecOpsConfig": { +"$ref": "GoogleChromeManagementVersionsV1GoogleSecOpsConfig", +"description": "Google SecOps connector config." +}, +"paloAltoNetworksConfig": { +"$ref": "GoogleChromeManagementVersionsV1PaloAltoNetworksConfig", +"description": "Palo Alto Networks connector config." +}, +"pubSubConfig": { +"$ref": "GoogleChromeManagementVersionsV1PubSubConfig", +"description": "Pub/Sub connector config." +}, +"pubSubXdrConfig": { +"$ref": "GoogleChromeManagementVersionsV1PubSubXdrConfig", +"description": "Pub/Sub XDR connector config." +}, +"splunkConfig": { +"$ref": "GoogleChromeManagementVersionsV1SplunkConfig", +"description": "Splunk connector config." +} +}, +"type": "object" +}, +"GoogleChromeManagementVersionsV1ConnectorConfigStatus": { +"description": "The status of the connector config.", +"id": "GoogleChromeManagementVersionsV1ConnectorConfigStatus", +"properties": { +"failureStartTime": { +"description": "Output only. Field recording time of the earliest failure since the last success event. This field is only set when the state is `DISABLED_BY_FAILURES`.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The state of the connector config. The connector state is disabled if the connector has not successfully sent an event in the last 24 hours.", +"enum": [ +"CONFIG_STATE_UNKNOWN", +"ENABLED", +"DISABLED_BY_FAILURES" +], +"enumDescriptions": [ +"Default value.", +"The connector config is enabled.", +"The connector config is transiently disabled due to failures." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Field recording time of most recent modification of the status. For ENABLED, this is the time the status was changed to ENABLED. For DISABLED_BY_FAILURES, this is the time of the most recent failed attempt to send an event to this config.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleChromeManagementVersionsV1CrowdStrikeConfig": { +"description": "CrowdStrike connector config.", +"id": "GoogleChromeManagementVersionsV1CrowdStrikeConfig", +"properties": { +"apiKey": { +"description": "Required. Input only. API key to use on the ingestion API.", +"type": "string" +}, +"host": { +"description": "Required. Host to identify the customer specific server to receive the events.", +"type": "string" +}, +"reportingSettings": { +"$ref": "GoogleChromeManagementVersionsV1ReportingSettings", +"description": "Required. The reporting settings for the CrowdStrike config." +} +}, +"type": "object" +}, +"GoogleChromeManagementVersionsV1CrowdStrikeFalconNextGenConfig": { +"description": "CrowdStrike Falcon Next Gen connector config.", +"id": "GoogleChromeManagementVersionsV1CrowdStrikeFalconNextGenConfig", +"properties": { +"apiKey": { +"description": "Required. Input only. API key to use on the ingestion API.", +"type": "string" +}, +"host": { +"description": "Required. Host to identify the customer specific server to receive the events.", +"type": "string" +}, +"reportingSettings": { +"$ref": "GoogleChromeManagementVersionsV1ReportingSettings", +"description": "Required. The reporting settings for the CrowdStrike Falcon Next Gen config." +} +}, +"type": "object" +}, +"GoogleChromeManagementVersionsV1CrowdStrikeXdrConfig": { +"description": "CrowdStrike XDR connector config.", +"id": "GoogleChromeManagementVersionsV1CrowdStrikeXdrConfig", +"properties": { +"apiKey": { +"description": "Required. Input only. API key to use on the ingestion API.", +"type": "string" +}, +"host": { +"description": "Required. Host to identify the customer specific server to receive the events.", +"type": "string" +}, +"xdrSettings": { +"$ref": "GoogleChromeManagementVersionsV1XdrSettings", +"description": "Required. The XDR settings for the CrowdStrike XDR config." +} +}, +"type": "object" +}, "GoogleChromeManagementVersionsV1DeviceInfo": { "description": "Information of a device that runs a Chrome browser profile.", "id": "GoogleChromeManagementVersionsV1DeviceInfo", @@ -6222,6 +6530,69 @@ false }, "type": "object" }, +"GoogleChromeManagementVersionsV1DeviceTrustConfig": { +"description": "Device trust config for device trust connectors.", +"id": "GoogleChromeManagementVersionsV1DeviceTrustConfig", +"properties": { +"scope": { +"description": "Required. The scope at which this configuration will be applied. Note that this only applies to Chrome browser, as in ChromeOS it's always applied.", +"enum": [ +"BROWSER_ENFORCEMENT_SCOPE_UNSPECIFIED", +"BROWSERS_ONLY", +"PROFILES_ONLY", +"BROWSERS_AND_PROFILES" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Only browsers are enforced.", +"Only profiles are enforced.", +"Both browsers and profiles are enforced." +], +"type": "string" +}, +"serviceAccounts": { +"description": "Required. A list of email addresses of the service accounts which are allowed to call the Verified Access API with full access.", +"items": { +"type": "string" +}, +"type": "array" +}, +"serviceProvider": { +"description": "Optional. The service provider for the device trust connector.", +"enum": [ +"SERVICE_PROVIDER_UNSPECIFIED", +"UNIVERSAL_DEVICE_TRUST", +"OKTA", +"PING_IDENTITY", +"ONELOGIN", +"DUO", +"ZSCALER", +"OMNISSA", +"JUMPCLOUD" +], +"enumDescriptions": [ +"Default value.", +"Universal device trust connector.", +"Okta service provider.", +"Ping Identity service provider.", +"OneLogin service provider.", +"Duo service provider.", +"Zscaler service provider.", +"Omnissa service provider.", +"JumpCloud service provider." +], +"type": "string" +}, +"urlMatchers": { +"description": "Required. List of URLs allowed to be part of the attestation flow to get the set of signals from the machine. URLs must have HTTPS scheme, e.g. \"https://example.com\". Wildcards, *, are allowed. For detailed information on valid URL patterns, please see https://cloud.google.com/docs/chrome-enterprise/policies/url-patterns.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleChromeManagementVersionsV1GenericCaConnection": { "description": "Describes a generic Certificate Authority Connection.", "id": "GoogleChromeManagementVersionsV1GenericCaConnection", @@ -6246,6 +6617,25 @@ false }, "type": "object" }, +"GoogleChromeManagementVersionsV1GoogleSecOpsConfig": { +"description": "Google SecOps connector config.", +"id": "GoogleChromeManagementVersionsV1GoogleSecOpsConfig", +"properties": { +"apiKey": { +"description": "Required. Input only. API key to use on the ingestion API.", +"type": "string" +}, +"host": { +"description": "Required. Host of ingestion API endpoint. Allows customer to upload events to servers in specific geographical regions. Existing configs that don't have this setting default to US.", +"type": "string" +}, +"reportingSettings": { +"$ref": "GoogleChromeManagementVersionsV1ReportingSettings", +"description": "Required. The reporting settings for the Google SecOps config." +} +}, +"type": "object" +}, "GoogleChromeManagementVersionsV1ListChromeBrowserProfileCommandsResponse": { "description": "Response to ListChromeBrowserProfileCommands method.", "id": "GoogleChromeManagementVersionsV1ListChromeBrowserProfileCommandsResponse", @@ -6292,6 +6682,29 @@ false }, "type": "object" }, +"GoogleChromeManagementVersionsV1ListConnectorConfigsResponse": { +"description": "Response to ListConnectorConfigs method.", +"id": "GoogleChromeManagementVersionsV1ListConnectorConfigsResponse", +"properties": { +"connectorConfigs": { +"description": "The list of connector configs returned.", +"items": { +"$ref": "GoogleChromeManagementVersionsV1ConnectorConfig" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The page token used to retrieve the next page of the listing request. If the token is empty, there are no more pages to retrieve.", +"type": "string" +}, +"totalSize": { +"description": "The total size of the connector configs list.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleChromeManagementVersionsV1MoveThirdPartyProfileUserRequest": { "description": "Request to MoveThirdPartyProfileUser method.", "id": "GoogleChromeManagementVersionsV1MoveThirdPartyProfileUserRequest", @@ -6315,6 +6728,55 @@ false }, "type": "object" }, +"GoogleChromeManagementVersionsV1PaloAltoNetworksConfig": { +"description": "Palo Alto Networks connector config.", +"id": "GoogleChromeManagementVersionsV1PaloAltoNetworksConfig", +"properties": { +"apiKey": { +"description": "Required. Input only. API key to use on the ingestion API.", +"type": "string" +}, +"host": { +"description": "Required. Host to identify the customer specific server to receive the events.", +"type": "string" +}, +"reportingSettings": { +"$ref": "GoogleChromeManagementVersionsV1ReportingSettings", +"description": "Required. The reporting settings for the Palo Alto Networks config." +} +}, +"type": "object" +}, +"GoogleChromeManagementVersionsV1PubSubConfig": { +"description": "Pub/Sub connector config.", +"id": "GoogleChromeManagementVersionsV1PubSubConfig", +"properties": { +"reportingSettings": { +"$ref": "GoogleChromeManagementVersionsV1ReportingSettings", +"description": "Required. The reporting settings for the Pub/Sub config." +}, +"topicFullPath": { +"description": "Required. The full path to the topic to send the event to.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleChromeManagementVersionsV1PubSubXdrConfig": { +"description": "Pub/Sub XDR connector config.", +"id": "GoogleChromeManagementVersionsV1PubSubXdrConfig", +"properties": { +"topicFullPath": { +"description": "Required. The full path to the topic to send the event to.", +"type": "string" +}, +"xdrSettings": { +"$ref": "GoogleChromeManagementVersionsV1XdrSettings", +"description": "Required. The XDR settings for the Pub/Sub XDR config." +} +}, +"type": "object" +}, "GoogleChromeManagementVersionsV1ReportingData": { "description": "Reporting data of a Chrome browser profile.", "id": "GoogleChromeManagementVersionsV1ReportingData", @@ -6563,6 +7025,98 @@ false }, "type": "object" }, +"GoogleChromeManagementVersionsV1ReportingSettings": { +"description": "Reporting settings for connector configs.", +"id": "GoogleChromeManagementVersionsV1ReportingSettings", +"properties": { +"enabledDefaultEvents": { +"description": "Optional. The list of user and browser events that are enabled for this connector. An empty list disables all default events, and using `ALL_DEFAULT_EVENTS` will enable all default events.", +"items": { +"enum": [ +"DEFAULT_EVENT_UNSPECIFIED", +"ALL_DEFAULT_EVENTS", +"BROWSER_CRASH_EVENT", +"BROWSER_EXTENSION_INSTALL_EVENT", +"CONTENT_TRANSFER_EVENT", +"CONTENT_UNSCANNED_EVENT", +"DATA_ACCESS_CONTROL_EVENT", +"MALWARE_TRANSFER_EVENT", +"PASSWORD_CHANGED_EVENT", +"PASSWORD_REUSE_EVENT", +"SENSITIVE_DATA_TRANSFER_EVENT", +"SUSPICIOUS_URL_EVENT", +"UNSAFE_SITE_VISIT_EVENT", +"URL_FILTERING_INTERSTITIAL_EVENT" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"All default events.", +"Browser crash event.", +"Browser extension install event.", +"Content transfer event.", +"Content unscanned event.", +"Data access control event.", +"Malware transfer event.", +"Password changed event.", +"Password reuse event.", +"Sensitive data transfer event.", +"Suspicious URL event.", +"Unsafe site visit event.", +"URL filtering interstitial event." +], +"type": "string" +}, +"type": "array" +}, +"enabledDeviceEvents": { +"description": "Optional. The list of device events that are enabled for this config. An empty list disables all device events, and using `ALL_DEVICE_EVENTS` will enable all device events.", +"items": { +"enum": [ +"DEVICE_EVENT_UNSPECIFIED", +"ALL_DEVICE_EVENTS", +"ADD_REMOVE_USER_EVENT", +"LOGIN_LOGOUT_EVENT", +"CRD_EVENT", +"PERIPHERAL_EVENT" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"All device events.", +"Add/remove user event.", +"Login/logout event.", +"CRD event.", +"Peripheral event." +], +"type": "string" +}, +"type": "array" +}, +"enabledOptInEvents": { +"description": "Optional. The list of opt-in events that are enabled for this config. An empty list disables all opt-in events, and using `ALL_OPT_IN_EVENTS` will enable all opt-in events.", +"items": { +"enum": [ +"OPT_IN_EVENT_UNSPECIFIED", +"ALL_OPT_IN_EVENTS", +"LOGIN_EVENT", +"PASSWORD_BREACH_EVENT", +"URL_NAVIGATION_EVENT", +"EXTENSION_TELEMETRY_EVENT" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"All opt-in events.", +"Login event.", +"Password breach event.", +"URL navigation event.", +"Extension telemetry event." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleChromeManagementVersionsV1ScepCaConnection": { "description": "Describes a SCEP Certificate Authority Connection.", "id": "GoogleChromeManagementVersionsV1ScepCaConnection", @@ -6714,6 +7268,38 @@ false }, "type": "object" }, +"GoogleChromeManagementVersionsV1SplunkConfig": { +"description": "Splunk connector config.", +"id": "GoogleChromeManagementVersionsV1SplunkConfig", +"properties": { +"hecToken": { +"description": "Required. Input only. The data input's HTTP Event Collector token to use as an Authorization header.", +"type": "string" +}, +"host": { +"description": "Required. Host to identify the customer specific server to receive the events.", +"type": "string" +}, +"portNumber": { +"description": "Optional. The port number to use. If not set, the default Splunk port is used.", +"format": "int32", +"type": "integer" +}, +"reportingSettings": { +"$ref": "GoogleChromeManagementVersionsV1ReportingSettings", +"description": "Required. The reporting settings for the Splunk config." +}, +"source": { +"description": "Optional. Optional source name to override the default one set in the Splunk admin console.", +"type": "string" +}, +"unsecureScheme": { +"description": "Optional. Whether to use an unsecure HTTP scheme. Defaults to false (HTTPS).", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleChromeManagementVersionsV1SubjectAltName": { "description": "Describes a subject alternative name.", "id": "GoogleChromeManagementVersionsV1SubjectAltName", @@ -6778,6 +7364,17 @@ false "properties": {}, "type": "object" }, +"GoogleChromeManagementVersionsV1XdrSettings": { +"description": "XDR settings for connector configs.", +"id": "GoogleChromeManagementVersionsV1XdrSettings", +"properties": { +"enableAllXdrEvents": { +"description": "Required. Whether to enable all XDR events.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", From ff30dfd0728d0719a42cb969049590dcef6db3d4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation
+ close()
Close httplib2 connections.
+ +Deletes a diagnostic.
+ +Gets a diagnostic.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists diagnostics.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
delete(name, x__xgafv=None)
+ Deletes a diagnostic.
+
+Args:
+ name: string, Required. The name of the diagnostic to delete. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+get(name, x__xgafv=None)
+ Gets a diagnostic.
+
+Args:
+ name: string, Required. The name of the diagnostic 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:
+
+ { # The diagnostic resource.
+ "analysisSummary": "A String", # Output only. The complete sequence of thoughts and actions taken by the agent.
+ "conversationFilter": "A String", # Output only. The filter used to select the conversations that were included in the diagnostic.
+ "createTime": "A String", # Output only. The time at which the diagnostic was created.
+ "name": "A String", # Immutable. Identifier. The resource name of the diagnostic.
+ "report": { # A diagnostic report containing aggregate metrics and intent breakdowns. # Output only. The report containing the findings of the diagnostic.
+ "intentStats": [ # Output only. A breakdown of metrics grouped by intent.
+ { # A breakdown of metrics grouped by intent.
+ "conversationCount": 42, # Output only. The number of conversations associated with this intent.
+ "intentDisplayName": "A String", # Output only. The display name of the intent.
+ "intentId": "A String", # Output only. The unique identifier for the intent (from Discovery Engine).
+ "lossPatterns": [ # Output only. A list of loss patterns identified for this intent.
+ { # A loss pattern of a virtual agent and suggested fixes.
+ "conversationIds": [ # Output only. A list of conversation IDs that match this loss pattern.
+ "A String",
+ ],
+ "description": "A String", # Output only. A markdown description of the loss pattern.
+ "displayName": "A String", # Output only. The display name of the loss pattern.
+ "examples": "A String", # Output only. A markdown of loss pattern examples.
+ "id": "A String", # Output only. The unique identifier for the loss pattern.
+ "percentage": 3.14, # Output only. The percentage of conversations that match this loss pattern.
+ "suggestedFixes": "A String", # Output only. A markdown description of the suggested fixes.
+ },
+ ],
+ "metrics": { # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
+ "a_key": { # Deprecated: MetricValue is no longer used for diagnostics.
+ "conversations": [ # Output only. The list of conversation names that contributed to this metric (hits). Format: `projects/{project}/locations/{location}/conversations/{conversation}`
+ "A String",
+ ],
+ "displayName": "A String", # Output only. The user-visible name of the metric (e.g., "Containment Rate").
+ "hitCount": 42, # Output only. The number of positive matches (hits) for this metric.
+ "metricType": "A String", # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
+ "sourceId": "A String", # Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.
+ "totalCount": 42, # Output only. The total number of items evaluated for this metric.
+ "value": 3.14, # Output only. The calculated value of the metric (usually a ratio or rate 0.0 - 1.0).
+ },
+ },
+ },
+ ],
+ "lossPatterns": [ # Output only. A list of loss patterns identified for the entire project/dataset.
+ { # A loss pattern of a virtual agent and suggested fixes.
+ "conversationIds": [ # Output only. A list of conversation IDs that match this loss pattern.
+ "A String",
+ ],
+ "description": "A String", # Output only. A markdown description of the loss pattern.
+ "displayName": "A String", # Output only. The display name of the loss pattern.
+ "examples": "A String", # Output only. A markdown of loss pattern examples.
+ "id": "A String", # Output only. The unique identifier for the loss pattern.
+ "percentage": 3.14, # Output only. The percentage of conversations that match this loss pattern.
+ "suggestedFixes": "A String", # Output only. A markdown description of the suggested fixes.
+ },
+ ],
+ "metrics": { # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
+ "a_key": { # Deprecated: MetricValue is no longer used for diagnostics.
+ "conversations": [ # Output only. The list of conversation names that contributed to this metric (hits). Format: `projects/{project}/locations/{location}/conversations/{conversation}`
+ "A String",
+ ],
+ "displayName": "A String", # Output only. The user-visible name of the metric (e.g., "Containment Rate").
+ "hitCount": 42, # Output only. The number of positive matches (hits) for this metric.
+ "metricType": "A String", # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
+ "sourceId": "A String", # Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.
+ "totalCount": 42, # Output only. The total number of items evaluated for this metric.
+ "value": 3.14, # Output only. The calculated value of the metric (usually a ratio or rate 0.0 - 1.0).
+ },
+ },
+ },
+}
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists diagnostics.
+
+Args:
+ parent: string, Required. The parent resource of the diagnostics. (required)
+ filter: string, Optional. A filter to apply to the list (e.g. `create_time > "2023-01-01T00:00:00Z"`).
+ pageSize: integer, Optional. The maximum number of diagnostics to return. The service may return fewer than this value. If unspecified, at most 100 diagnostics 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 `ListDiagnostics` call. Provide this to retrieve the subsequent page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response from a ListDiagnostics request.
+ "diagnostics": [ # Optional. The diagnostics that match the request.
+ { # The diagnostic resource.
+ "analysisSummary": "A String", # Output only. The complete sequence of thoughts and actions taken by the agent.
+ "conversationFilter": "A String", # Output only. The filter used to select the conversations that were included in the diagnostic.
+ "createTime": "A String", # Output only. The time at which the diagnostic was created.
+ "name": "A String", # Immutable. Identifier. The resource name of the diagnostic.
+ "report": { # A diagnostic report containing aggregate metrics and intent breakdowns. # Output only. The report containing the findings of the diagnostic.
+ "intentStats": [ # Output only. A breakdown of metrics grouped by intent.
+ { # A breakdown of metrics grouped by intent.
+ "conversationCount": 42, # Output only. The number of conversations associated with this intent.
+ "intentDisplayName": "A String", # Output only. The display name of the intent.
+ "intentId": "A String", # Output only. The unique identifier for the intent (from Discovery Engine).
+ "lossPatterns": [ # Output only. A list of loss patterns identified for this intent.
+ { # A loss pattern of a virtual agent and suggested fixes.
+ "conversationIds": [ # Output only. A list of conversation IDs that match this loss pattern.
+ "A String",
+ ],
+ "description": "A String", # Output only. A markdown description of the loss pattern.
+ "displayName": "A String", # Output only. The display name of the loss pattern.
+ "examples": "A String", # Output only. A markdown of loss pattern examples.
+ "id": "A String", # Output only. The unique identifier for the loss pattern.
+ "percentage": 3.14, # Output only. The percentage of conversations that match this loss pattern.
+ "suggestedFixes": "A String", # Output only. A markdown description of the suggested fixes.
+ },
+ ],
+ "metrics": { # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
+ "a_key": { # Deprecated: MetricValue is no longer used for diagnostics.
+ "conversations": [ # Output only. The list of conversation names that contributed to this metric (hits). Format: `projects/{project}/locations/{location}/conversations/{conversation}`
+ "A String",
+ ],
+ "displayName": "A String", # Output only. The user-visible name of the metric (e.g., "Containment Rate").
+ "hitCount": 42, # Output only. The number of positive matches (hits) for this metric.
+ "metricType": "A String", # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
+ "sourceId": "A String", # Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.
+ "totalCount": 42, # Output only. The total number of items evaluated for this metric.
+ "value": 3.14, # Output only. The calculated value of the metric (usually a ratio or rate 0.0 - 1.0).
+ },
+ },
+ },
+ ],
+ "lossPatterns": [ # Output only. A list of loss patterns identified for the entire project/dataset.
+ { # A loss pattern of a virtual agent and suggested fixes.
+ "conversationIds": [ # Output only. A list of conversation IDs that match this loss pattern.
+ "A String",
+ ],
+ "description": "A String", # Output only. A markdown description of the loss pattern.
+ "displayName": "A String", # Output only. The display name of the loss pattern.
+ "examples": "A String", # Output only. A markdown of loss pattern examples.
+ "id": "A String", # Output only. The unique identifier for the loss pattern.
+ "percentage": 3.14, # Output only. The percentage of conversations that match this loss pattern.
+ "suggestedFixes": "A String", # Output only. A markdown description of the suggested fixes.
+ },
+ ],
+ "metrics": { # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
+ "a_key": { # Deprecated: MetricValue is no longer used for diagnostics.
+ "conversations": [ # Output only. The list of conversation names that contributed to this metric (hits). Format: `projects/{project}/locations/{location}/conversations/{conversation}`
+ "A String",
+ ],
+ "displayName": "A String", # Output only. The user-visible name of the metric (e.g., "Containment Rate").
+ "hitCount": 42, # Output only. The number of positive matches (hits) for this metric.
+ "metricType": "A String", # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
+ "sourceId": "A String", # Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.
+ "totalCount": 42, # Output only. The total number of items evaluated for this metric.
+ "value": 3.14, # Output only. The calculated value of the metric (usually a ratio or rate 0.0 - 1.0).
+ },
+ },
+ },
+ },
+ ],
+ "nextPageToken": "A String", # Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+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. ++
Returns the datasets Resource.
+
+ diagnostics()
+
Returns the diagnostics Resource.
+ @@ -161,6 +166,9 @@Close httplib2 connections.
+
+ diagnoseConversations(parent, body=None, x__xgafv=None)
Analyzes conversation data using specialized agentic workflows, such as ReAct, to diagnose issues and provide insights.
generativeInsights(location, body=None, x__xgafv=None)
Natural language based Insights which powers the next generation of dashboards in Insights. Next generation of QueryMetrics.
@@ -352,6 +360,71 @@Close httplib2 connections.+
diagnoseConversations(parent, body=None, x__xgafv=None)
+ Analyzes conversation data using specialized agentic workflows, such as ReAct, to diagnose issues and provide insights.
+
+Args:
+ parent: string, Required. The parent resource where the analysis will be performed. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request to analyze conversation data using agentic workflows. This RPC triggers a complex analysis process that may involve several steps of reasoning and tool execution.
+ "dryRun": True or False, # Optional. If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task.
+ "filter": "A String", # Optional. AIP-160 compliant filter for selecting target conversations.
+ "fullReport": True or False, # Optional. If true, the agent will generate a full diagnostic report for all sub-agents.
+ "instructions": "A String", # Optional. Specific instructions for the agent.
+ "maxSteps": 42, # Optional. The maximum number of steps the agent can take during the execution of the task. Defaults to 10.
+ "metricType": "A String", # Optional. The type of metric being diagnosed.
+ "outputConfig": { # Configuration for where to export or return the analysis findings. # Optional. The configuration for the output of the task.
+ "bigqueryDestination": { # BigQuery destination configuration. # Optional. Export to BigQuery.
+ "dataset": "A String", # Required. The name of the BigQuery dataset.
+ "projectId": "A String", # Optional. A project ID or number.
+ "table": "A String", # Required. The BigQuery table name.
+ },
+ "gcsDestination": { # Cloud Storage destination configuration. # Optional. Export to a Cloud Storage bucket.
+ "uri": "A String", # Required. The Cloud Storage URI to export the results to.
+ },
+ "googleSheetsDestination": { # Google Sheets destination configuration. # Optional. Export directly to a Google Sheet.
+ "sheet": "A String", # Optional. The sheet name.
+ "spreadsheetId": "A String", # Optional. An existing Google Sheets ID.
+ },
+ },
+ "parent": "A String", # Required. The parent resource where the analysis will be performed.
+ "requestId": "A String", # Optional. Required. A unique ID that identifies the request. If the service receives two `DiagnoseConversationsRequest`s with the same `request_id`, then the second request will be ignored; instead, the response of the first request will be returned. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
+ "taskQuery": "A String", # Optional. A natural language description of the analysis goal or question.
+ "validateOnly": True or False, # Optional. If true, the request will only be validated (permissions, filter syntax, etc.) without actually triggering the analysis.
+}
+
+ 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.
+ },
+}
+generativeInsights(location, body=None, x__xgafv=None)
Natural language based Insights which powers the next generation of dashboards in Insights. Next generation of QueryMetrics. @@ -506,6 +579,14 @@Method Details
}, "conversationTtl": "A String", # The default TTL for newly-created conversations. If a conversation has a specified expiration, that value will be used instead. Changing this value will not change the expiration of existing conversations. Conversations with no expire time persist until they are deleted. "createTime": "A String", # Output only. The time at which the settings was created. + "diagnosticMetricConfig": { # Configuration for diagnostic metrics. # Optional. Configuration for diagnostic metrics. + "metrics": { # Optional. A map of diagnostic metrics. The key is a unique identifier for the metric (e.g., "containment"). + "a_key": { # A definition for a metric to be calculated during analysis. + "displayName": "A String", # Output only. The user-visible name of the metric (e.g., "Containment Rate"). + "sourceId": "A String", # Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric. + }, + }, + }, "languageCode": "A String", # A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to "en-US" if it is neither specified on the segment nor here. "name": "A String", # Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings "pubsubNotificationSettings": { # A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "ingest-conversations": Notify each time an IngestConversations LRO is complete. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO is complete. * "update-or-analyze-conversation": Notify when an analysis for a conversation is completed or when the conversation is updated. The message will contain the conversation with transcript, analysis and other metadata. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic} @@ -1071,6 +1152,84 @@Method Details
"title": "A String", # Article title. "uri": "A String", # Article URI. }, + "cesEndSessionAnnotation": { # The CES end session annotation. # The CES end session annotation. + "endSession": { # Indicates the session has terminated, due to either successful completion (e.g. user says "Good bye!" ) or an agent escalation. The agent will not process any further inputs after session is terminated and the client should half-close and disconnect after receiving all remaining responses from the agent. # End session signal from CES. + "metadata": { # Optional. Provides additional information about the end session signal, such as the reason for ending the session. + "a_key": "", # Properties of the object. + }, + }, + }, + "cesTurnAnnotation": { # The CES diagnostic information. # The CES turn annotation. + "messages": [ # The messages in the turn. + { # A message within a conversation. + "chunks": [ # Optional. Content of the message as a series of chunks. + { # A chunk of content within a message. + "agentTransfer": { # Represents an event indicating the transfer of a conversation to a different agent. # Optional. Agent transfer event. + "displayName": "A String", # Output only. Display name of the agent. + "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. + "a_key": "", # Properties of the object. + }, + "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "data": "A String", # Required. Raw bytes of the image. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp + }, + "payload": { # Optional. Custom payload data. + "a_key": "", # Properties of the object. + }, + "text": "A String", # Optional. Text data. + "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Tool execution request. + "args": { # Optional. The input parameters and values for the tool in JSON object format. + "a_key": "", # Properties of the object. + }, + "displayName": "A String", # Output only. Display name of the tool. + "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. + "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + "toolResponse": { # The execution result of a specific tool from the client or the agent. # Optional. Tool execution response. + "displayName": "A String", # Output only. Display name of the tool. + "id": "A String", # Optional. The matching ID of the tool call the response is for. + "response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + "transcript": "A String", # Optional. Transcript associated with the audio. + "updatedVariables": { # A struct represents variables that were updated in the conversation, keyed by variable names. + "a_key": "", # Properties of the object. + }, + }, + ], + "eventTime": "A String", # Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example. + "role": "A String", # Optional. The role within the conversation, e.g., user, agent. + }, + ], + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # The root span of the action processing. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: GoogleCloudCesV1mainSpan + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, + }, "conversationSummarizationSuggestion": { # Conversation summarization suggestion data. # Conversation summarization suggestion data. "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} "confidence": 3.14, # The confidence score of the summarization. @@ -1319,6 +1478,14 @@Method Details
}, "conversationTtl": "A String", # The default TTL for newly-created conversations. If a conversation has a specified expiration, that value will be used instead. Changing this value will not change the expiration of existing conversations. Conversations with no expire time persist until they are deleted. "createTime": "A String", # Output only. The time at which the settings was created. + "diagnosticMetricConfig": { # Configuration for diagnostic metrics. # Optional. Configuration for diagnostic metrics. + "metrics": { # Optional. A map of diagnostic metrics. The key is a unique identifier for the metric (e.g., "containment"). + "a_key": { # A definition for a metric to be calculated during analysis. + "displayName": "A String", # Output only. The user-visible name of the metric (e.g., "Containment Rate"). + "sourceId": "A String", # Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric. + }, + }, + }, "languageCode": "A String", # A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to "en-US" if it is neither specified on the segment nor here. "name": "A String", # Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings "pubsubNotificationSettings": { # A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "ingest-conversations": Notify each time an IngestConversations LRO is complete. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO is complete. * "update-or-analyze-conversation": Notify when an analysis for a conversation is completed or when the conversation is updated. The message will contain the conversation with transcript, analysis and other metadata. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic} @@ -1383,6 +1550,14 @@Method Details
}, "conversationTtl": "A String", # The default TTL for newly-created conversations. If a conversation has a specified expiration, that value will be used instead. Changing this value will not change the expiration of existing conversations. Conversations with no expire time persist until they are deleted. "createTime": "A String", # Output only. The time at which the settings was created. + "diagnosticMetricConfig": { # Configuration for diagnostic metrics. # Optional. Configuration for diagnostic metrics. + "metrics": { # Optional. A map of diagnostic metrics. The key is a unique identifier for the metric (e.g., "containment"). + "a_key": { # A definition for a metric to be calculated during analysis. + "displayName": "A String", # Output only. The user-visible name of the metric (e.g., "Containment Rate"). + "sourceId": "A String", # Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric. + }, + }, + }, "languageCode": "A String", # A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to "en-US" if it is neither specified on the segment nor here. "name": "A String", # Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings "pubsubNotificationSettings": { # A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "ingest-conversations": Notify each time an IngestConversations LRO is complete. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO is complete. * "update-or-analyze-conversation": Notify when an analysis for a conversation is completed or when the conversation is updated. The message will contain the conversation with transcript, analysis and other metadata. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic} diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index f887566db9..8bbb3fba86 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -193,6 +193,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"diagnoseConversations": { +"description": "Analyzes conversation data using specialized agentic workflows, such as ReAct, to diagnose issues and provide insights.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:diagnoseConversations", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.diagnoseConversations", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource where the analysis will be performed.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}:diagnoseConversations", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1DiagnoseConversationsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "generativeInsights": { "description": "Natural language based Insights which powers the next generation of dashboards in Insights. Next generation of QueryMetrics.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generativeInsights", @@ -4479,6 +4507,101 @@ } } }, +"diagnostics": { +"methods": { +"delete": { +"description": "Deletes a diagnostic.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/diagnostics/{diagnosticsId}", +"httpMethod": "DELETE", +"id": "contactcenterinsights.projects.locations.diagnostics.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the diagnostic to delete.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/diagnostics/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a diagnostic.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/diagnostics/{diagnosticsId}", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.diagnostics.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the diagnostic to retrieve.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/diagnostics/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1Diagnostic" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists diagnostics.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/diagnostics", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.diagnostics.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter to apply to the list (e.g. `create_time > \"2023-01-01T00:00:00Z\"`).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of diagnostics to return. The service may return fewer than this value. If unspecified, at most 100 diagnostics will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListDiagnostics` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the diagnostics.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/diagnostics", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1ListDiagnosticsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "encryptionSpec": { "methods": { "initialize": { @@ -6101,151 +6224,194 @@ } } }, -"revision": "20260401", +"revision": "20260410", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { -"GoogleCloudContactcenterinsightsV1Analysis": { -"description": "The analysis resource.", -"id": "GoogleCloudContactcenterinsightsV1Analysis", +"GoogleCloudCesV1mainAgentTransfer": { +"description": "Represents an event indicating the transfer of a conversation to a different agent.", +"id": "GoogleCloudCesV1mainAgentTransfer", "properties": { -"analysisResult": { -"$ref": "GoogleCloudContactcenterinsightsV1AnalysisResult", -"description": "Output only. The result of the analysis, which is populated when the analysis finishes.", -"readOnly": true -}, -"annotatorSelector": { -"$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", -"description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." -}, -"createTime": { -"description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", -"format": "google-datetime", +"displayName": { +"description": "Output only. Display name of the agent.", "readOnly": true, "type": "string" }, -"name": { -"description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", -"type": "string" -}, -"requestTime": { -"description": "Output only. The time at which the analysis was requested.", -"format": "google-datetime", -"readOnly": true, +"targetAgent": { +"description": "Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1AnalysisResult": { -"description": "The result of an analysis.", -"id": "GoogleCloudContactcenterinsightsV1AnalysisResult", +"GoogleCloudCesV1mainBlob": { +"description": "Represents a blob input or output in the conversation.", +"id": "GoogleCloudCesV1mainBlob", "properties": { -"callAnalysisMetadata": { -"$ref": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata", -"description": "Call-specific metadata created by the analysis." +"data": { +"description": "Required. Raw bytes of the blob.", +"format": "byte", +"type": "string" }, -"endTime": { -"description": "The time at which the analysis ended.", -"format": "google-datetime", +"mimeType": { +"description": "Required. The IANA standard MIME type of the source data.", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata": { -"description": "Call-specific metadata created during analysis.", -"id": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata", +"GoogleCloudCesV1mainChunk": { +"description": "A chunk of content within a message.", +"id": "GoogleCloudCesV1mainChunk", "properties": { -"annotations": { -"description": "A list of call annotations that apply to this call.", -"items": { -"$ref": "GoogleCloudContactcenterinsightsV1CallAnnotation" +"agentTransfer": { +"$ref": "GoogleCloudCesV1mainAgentTransfer", +"description": "Optional. Agent transfer event." }, -"type": "array" +"blob": { +"$ref": "GoogleCloudCesV1mainBlob", +"description": "Optional. Blob data." }, -"entities": { +"defaultVariables": { "additionalProperties": { -"$ref": "GoogleCloudContactcenterinsightsV1Entity" +"description": "Properties of the object.", +"type": "any" }, -"description": "All the entities in the call.", +"description": "A struct represents default variables at the start of the conversation, keyed by variable names.", "type": "object" }, -"intents": { +"image": { +"$ref": "GoogleCloudCesV1mainImage", +"description": "Optional. Image data." +}, +"payload": { "additionalProperties": { -"$ref": "GoogleCloudContactcenterinsightsV1Intent" +"description": "Properties of the object.", +"type": "any" }, -"description": "All the matched intents in the call.", +"description": "Optional. Custom payload data.", "type": "object" }, -"issueModelResult": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueModelResult", -"description": "Overall conversation-level issue modeling result." +"text": { +"description": "Optional. Text data.", +"type": "string" }, -"phraseMatchers": { +"toolCall": { +"$ref": "GoogleCloudCesV1mainToolCall", +"description": "Optional. Tool execution request." +}, +"toolResponse": { +"$ref": "GoogleCloudCesV1mainToolResponse", +"description": "Optional. Tool execution response." +}, +"transcript": { +"description": "Optional. Transcript associated with the audio.", +"type": "string" +}, +"updatedVariables": { "additionalProperties": { -"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData" +"description": "Properties of the object.", +"type": "any" }, -"description": "All the matched phrase matchers in the call.", +"description": "A struct represents variables that were updated in the conversation, keyed by variable names.", "type": "object" +} }, -"qaScorecardResults": { -"description": "Results of scoring QaScorecards.", -"items": { -"$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResult" +"type": "object" }, -"type": "array" +"GoogleCloudCesV1mainEndSession": { +"description": "Indicates the session has terminated, due to either successful completion (e.g. user says \"Good bye!\" ) or an agent escalation. The agent will not process any further inputs after session is terminated and the client should half-close and disconnect after receiving all remaining responses from the agent.", +"id": "GoogleCloudCesV1mainEndSession", +"properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" }, -"sentiments": { -"description": "Overall conversation-level sentiment for each channel of the call.", +"description": "Optional. Provides additional information about the end session signal, such as the reason for ending the session.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudCesV1mainImage": { +"description": "Represents an image input or output in the conversation.", +"id": "GoogleCloudCesV1mainImage", +"properties": { +"data": { +"description": "Required. Raw bytes of the image.", +"format": "byte", +"type": "string" +}, +"mimeType": { +"description": "Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudCesV1mainMessage": { +"description": "A message within a conversation.", +"id": "GoogleCloudCesV1mainMessage", +"properties": { +"chunks": { +"description": "Optional. Content of the message as a series of chunks.", "items": { -"$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment" +"$ref": "GoogleCloudCesV1mainChunk" }, "type": "array" }, -"silence": { -"$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence", -"description": "Overall conversation-level silence during the call." +"eventTime": { +"description": "Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.", +"format": "google-datetime", +"type": "string" +}, +"role": { +"description": "Optional. The role within the conversation, e.g., user, agent.", +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1AnalysisRule": { -"description": "The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.", -"id": "GoogleCloudContactcenterinsightsV1AnalysisRule", +"GoogleCloudCesV1mainSpan": { +"description": "A span is a unit of work or a single operation during the request processing.", +"id": "GoogleCloudCesV1mainSpan", "properties": { -"active": { -"description": "If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.", -"type": "boolean" +"attributes": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" }, -"analysisPercentage": { -"description": "Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.", -"format": "double", -"type": "number" +"description": "Output only. Key-value attributes associated with the span.", +"readOnly": true, +"type": "object" }, -"annotatorSelector": { -"$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", -"description": "Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run." +"childSpans": { +"description": "Output only. The child spans that are nested under this span.", +"items": { +"$ref": "GoogleCloudCesV1mainSpan" }, -"conversationFilter": { -"description": "Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", -"type": "string" +"readOnly": true, +"type": "array" }, -"createTime": { -"description": "Output only. The time at which this analysis rule was created.", -"format": "google-datetime", +"duration": { +"description": "Output only. The duration of the span.", +"format": "google-duration", "readOnly": true, "type": "string" }, -"displayName": { -"description": "Display Name of the analysis rule.", +"endTime": { +"description": "Output only. The end time of the span.", +"format": "google-datetime", +"readOnly": true, "type": "string" }, "name": { -"description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}", +"description": "Output only. The name of the span.", +"readOnly": true, "type": "string" }, -"updateTime": { -"description": "Output only. The most recent time at which this analysis rule was updated.", +"startTime": { +"description": "Output only. The start time of the span.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6253,20 +6419,248 @@ }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1AnnotationBoundary": { -"description": "A point in a conversation that marks the start or the end of an annotation.", -"id": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", +"GoogleCloudCesV1mainToolCall": { +"description": "Request for the client or the agent to execute the specified tool.", +"id": "GoogleCloudCesV1mainToolCall", "properties": { -"transcriptIndex": { -"description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.", -"format": "int32", -"type": "integer" +"args": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" }, -"wordIndex": { -"description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.", -"format": "int32", -"type": "integer" -} +"description": "Optional. The input parameters and values for the tool in JSON object format.", +"type": "object" +}, +"displayName": { +"description": "Output only. Display name of the tool.", +"readOnly": true, +"type": "string" +}, +"id": { +"description": "Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.", +"type": "string" +}, +"tool": { +"description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", +"type": "string" +}, +"toolsetTool": { +"$ref": "GoogleCloudCesV1mainToolsetTool", +"description": "Optional. The toolset tool to execute." +} +}, +"type": "object" +}, +"GoogleCloudCesV1mainToolResponse": { +"description": "The execution result of a specific tool from the client or the agent.", +"id": "GoogleCloudCesV1mainToolResponse", +"properties": { +"displayName": { +"description": "Output only. Display name of the tool.", +"readOnly": true, +"type": "string" +}, +"id": { +"description": "Optional. The matching ID of the tool call the response is for.", +"type": "string" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Required. The tool execution result in JSON object format. Use \"output\" key to specify tool response and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as tool execution result.", +"type": "object" +}, +"tool": { +"description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", +"type": "string" +}, +"toolsetTool": { +"$ref": "GoogleCloudCesV1mainToolsetTool", +"description": "Optional. The toolset tool that got executed." +} +}, +"type": "object" +}, +"GoogleCloudCesV1mainToolsetTool": { +"description": "A tool that is created from a toolset.", +"id": "GoogleCloudCesV1mainToolsetTool", +"properties": { +"toolId": { +"description": "Optional. The tool ID to filter the tools to retrieve the schema for.", +"type": "string" +}, +"toolset": { +"description": "Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1Analysis": { +"description": "The analysis resource.", +"id": "GoogleCloudContactcenterinsightsV1Analysis", +"properties": { +"analysisResult": { +"$ref": "GoogleCloudContactcenterinsightsV1AnalysisResult", +"description": "Output only. The result of the analysis, which is populated when the analysis finishes.", +"readOnly": true +}, +"annotatorSelector": { +"$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", +"description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." +}, +"createTime": { +"description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", +"type": "string" +}, +"requestTime": { +"description": "Output only. The time at which the analysis was requested.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1AnalysisResult": { +"description": "The result of an analysis.", +"id": "GoogleCloudContactcenterinsightsV1AnalysisResult", +"properties": { +"callAnalysisMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata", +"description": "Call-specific metadata created by the analysis." +}, +"endTime": { +"description": "The time at which the analysis ended.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata": { +"description": "Call-specific metadata created during analysis.", +"id": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata", +"properties": { +"annotations": { +"description": "A list of call annotations that apply to this call.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1CallAnnotation" +}, +"type": "array" +}, +"entities": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1Entity" +}, +"description": "All the entities in the call.", +"type": "object" +}, +"intents": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1Intent" +}, +"description": "All the matched intents in the call.", +"type": "object" +}, +"issueModelResult": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueModelResult", +"description": "Overall conversation-level issue modeling result." +}, +"phraseMatchers": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData" +}, +"description": "All the matched phrase matchers in the call.", +"type": "object" +}, +"qaScorecardResults": { +"description": "Results of scoring QaScorecards.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResult" +}, +"type": "array" +}, +"sentiments": { +"description": "Overall conversation-level sentiment for each channel of the call.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment" +}, +"type": "array" +}, +"silence": { +"$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence", +"description": "Overall conversation-level silence during the call." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1AnalysisRule": { +"description": "The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.", +"id": "GoogleCloudContactcenterinsightsV1AnalysisRule", +"properties": { +"active": { +"description": "If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.", +"type": "boolean" +}, +"analysisPercentage": { +"description": "Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.", +"format": "double", +"type": "number" +}, +"annotatorSelector": { +"$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", +"description": "Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run." +}, +"conversationFilter": { +"description": "Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", +"type": "string" +}, +"createTime": { +"description": "Output only. The time at which this analysis rule was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Display Name of the analysis rule.", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}", +"type": "string" +}, +"updateTime": { +"description": "Output only. The most recent time at which this analysis rule was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1AnnotationBoundary": { +"description": "A point in a conversation that marks the start or the end of an annotation.", +"id": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", +"properties": { +"transcriptIndex": { +"description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.", +"format": "int32", +"type": "integer" +}, +"wordIndex": { +"description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.", +"format": "int32", +"type": "integer" +} }, "type": "object" }, @@ -7281,6 +7675,35 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation": { +"description": "The CES end session annotation.", +"id": "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation", +"properties": { +"endSession": { +"$ref": "GoogleCloudCesV1mainEndSession", +"description": "End session signal from CES." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1CesTurnAnnotation": { +"description": "The CES diagnostic information.", +"id": "GoogleCloudContactcenterinsightsV1CesTurnAnnotation", +"properties": { +"messages": { +"description": "The messages in the turn.", +"items": { +"$ref": "GoogleCloudCesV1mainMessage" +}, +"type": "array" +}, +"rootSpan": { +"$ref": "GoogleCloudCesV1mainSpan", +"description": "The root span of the action processing." +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1Chart": { "description": "Configurable dashboard's widget that displays data as a chart.", "id": "GoogleCloudContactcenterinsightsV1Chart", @@ -8533,35 +8956,306 @@ true "properties": {}, "type": "object" }, -"GoogleCloudContactcenterinsightsV1DialogflowIntent": { -"description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", -"id": "GoogleCloudContactcenterinsightsV1DialogflowIntent", +"GoogleCloudContactcenterinsightsV1DiagnoseConversationsMetadata": { +"description": "Metadata for a DiagnoseConversations operation.", +"id": "GoogleCloudContactcenterinsightsV1DiagnoseConversationsMetadata", "properties": { -"displayName": { -"description": "The human-readable name of the intent.", +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, "type": "string" -} -}, -"type": "object" }, -"GoogleCloudContactcenterinsightsV1DialogflowInteractionData": { -"description": "Dialogflow interaction data.", -"id": "GoogleCloudContactcenterinsightsV1DialogflowInteractionData", -"properties": { -"confidence": { -"description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", -"format": "float", -"type": "number" +"diagnosticReport": { +"$ref": "GoogleCloudContactcenterinsightsV1DiagnosticReport", +"description": "Output only. The diagnostic report containing metrics and intent breakdowns.", +"readOnly": true }, -"dialogflowIntentId": { -"description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}", +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, "type": "string" -} }, -"type": "object" +"fullReport": { +"description": "Output only. If true, the agent generated a full diagnostic report for all sub-agents.", +"readOnly": true, +"type": "boolean" }, -"GoogleCloudContactcenterinsightsV1DialogflowSource": { -"description": "A Dialogflow source of conversation data.", +"latestStep": { +"$ref": "GoogleCloudContactcenterinsightsV1SherlockStep", +"description": "Output only. The most recent thought or action from the agent.", +"readOnly": true +}, +"metricType": { +"description": "Output only. The type of metric being diagnosed.", +"enum": [ +"DIAGNOSTIC_METRIC_TYPE_UNSPECIFIED", +"ESCALATION", +"CONTAINMENT" +], +"enumDescriptions": [ +"Metric type is unspecified.", +"Escalation rate.", +"Containment rate." +], +"readOnly": true, +"type": "string" +}, +"partialTrajectories": { +"deprecated": true, +"description": "Output only. Deprecated: Use partial_trajectory_steps instead. The intermediate trajectory updates (partial trajectory).", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"partialTrajectorySteps": { +"description": "Output only. The intermediate trajectory updates. This can be used for live progress tracking of the agent's thoughts and actions as it works through the analysis.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1SherlockStep" +}, +"readOnly": true, +"type": "array" +}, +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1DiagnoseConversationsRequest", +"description": "Output only. The request that created the operation.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1DiagnoseConversationsRequest": { +"description": "The request to analyze conversation data using agentic workflows. This RPC triggers a complex analysis process that may involve several steps of reasoning and tool execution.", +"id": "GoogleCloudContactcenterinsightsV1DiagnoseConversationsRequest", +"properties": { +"dryRun": { +"description": "Optional. If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task.", +"type": "boolean" +}, +"filter": { +"description": "Optional. AIP-160 compliant filter for selecting target conversations.", +"type": "string" +}, +"fullReport": { +"description": "Optional. If true, the agent will generate a full diagnostic report for all sub-agents.", +"type": "boolean" +}, +"instructions": { +"description": "Optional. Specific instructions for the agent.", +"type": "string" +}, +"maxSteps": { +"description": "Optional. The maximum number of steps the agent can take during the execution of the task. Defaults to 10.", +"format": "int32", +"type": "integer" +}, +"metricType": { +"description": "Optional. The type of metric being diagnosed.", +"enum": [ +"DIAGNOSTIC_METRIC_TYPE_UNSPECIFIED", +"ESCALATION", +"CONTAINMENT" +], +"enumDescriptions": [ +"Metric type is unspecified.", +"Escalation rate.", +"Containment rate." +], +"type": "string" +}, +"outputConfig": { +"$ref": "GoogleCloudContactcenterinsightsV1OutputConfig", +"description": "Optional. The configuration for the output of the task." +}, +"parent": { +"description": "Required. The parent resource where the analysis will be performed.", +"type": "string" +}, +"requestId": { +"description": "Optional. Required. A unique ID that identifies the request. If the service receives two `DiagnoseConversationsRequest`s with the same `request_id`, then the second request will be ignored; instead, the response of the first request will be returned. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", +"type": "string" +}, +"taskQuery": { +"description": "Optional. A natural language description of the analysis goal or question.", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If true, the request will only be validated (permissions, filter syntax, etc.) without actually triggering the analysis.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1DiagnoseConversationsResponse": { +"description": "The response from a DiagnoseConversations request.", +"id": "GoogleCloudContactcenterinsightsV1DiagnoseConversationsResponse", +"properties": { +"answer": { +"description": "Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker.", +"readOnly": true, +"type": "string" +}, +"exportUri": { +"description": "Output only. If an external destination was requested, the URI of the exported data.", +"readOnly": true, +"type": "string" +}, +"fullTrajectories": { +"deprecated": true, +"description": "Output only. Deprecated: Use full_trajectory_steps instead. The complete sequence of thoughts and actions (full trajectory).", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"fullTrajectorySteps": { +"description": "Output only. The complete sequence of thoughts and actions taken by the agent.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1SherlockStep" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1Diagnostic": { +"description": "The diagnostic resource.", +"id": "GoogleCloudContactcenterinsightsV1Diagnostic", +"properties": { +"analysisSummary": { +"description": "Output only. The complete sequence of thoughts and actions taken by the agent.", +"readOnly": true, +"type": "string" +}, +"conversationFilter": { +"description": "Output only. The filter used to select the conversations that were included in the diagnostic.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time at which the diagnostic was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The resource name of the diagnostic.", +"type": "string" +}, +"report": { +"$ref": "GoogleCloudContactcenterinsightsV1DiagnosticReport", +"description": "Output only. The report containing the findings of the diagnostic.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1DiagnosticReport": { +"description": "A diagnostic report containing aggregate metrics and intent breakdowns.", +"id": "GoogleCloudContactcenterinsightsV1DiagnosticReport", +"properties": { +"intentStats": { +"description": "Output only. A breakdown of metrics grouped by intent.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1DiagnosticReportIntentStats" +}, +"readOnly": true, +"type": "array" +}, +"lossPatterns": { +"description": "Output only. A list of loss patterns identified for the entire project/dataset.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1LossPattern" +}, +"readOnly": true, +"type": "array" +}, +"metrics": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1MetricValue" +}, +"deprecated": true, +"description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1DiagnosticReportIntentStats": { +"description": "A breakdown of metrics grouped by intent.", +"id": "GoogleCloudContactcenterinsightsV1DiagnosticReportIntentStats", +"properties": { +"conversationCount": { +"description": "Output only. The number of conversations associated with this intent.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"intentDisplayName": { +"description": "Output only. The display name of the intent.", +"readOnly": true, +"type": "string" +}, +"intentId": { +"description": "Output only. The unique identifier for the intent (from Discovery Engine).", +"readOnly": true, +"type": "string" +}, +"lossPatterns": { +"description": "Output only. A list of loss patterns identified for this intent.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1LossPattern" +}, +"readOnly": true, +"type": "array" +}, +"metrics": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1MetricValue" +}, +"deprecated": true, +"description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1DialogflowIntent": { +"description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", +"id": "GoogleCloudContactcenterinsightsV1DialogflowIntent", +"properties": { +"displayName": { +"description": "The human-readable name of the intent.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1DialogflowInteractionData": { +"description": "Dialogflow interaction data.", +"id": "GoogleCloudContactcenterinsightsV1DialogflowInteractionData", +"properties": { +"confidence": { +"description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", +"format": "float", +"type": "number" +}, +"dialogflowIntentId": { +"description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1DialogflowSource": { +"description": "A Dialogflow source of conversation data.", "id": "GoogleCloudContactcenterinsightsV1DialogflowSource", "properties": { "audioUri": { @@ -10563,6 +11257,24 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1ListDiagnosticsResponse": { +"description": "The response from a ListDiagnostics request.", +"id": "GoogleCloudContactcenterinsightsV1ListDiagnosticsResponse", +"properties": { +"diagnostics": { +"description": "Optional. The diagnostics that match the request.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1Diagnostic" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse": { "description": "The response for listing feedback labels.", "id": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse", @@ -10735,71 +11447,193 @@ true }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1Note": { -"description": "The conversation assessment note resource.", -"id": "GoogleCloudContactcenterinsightsV1Note", +"GoogleCloudContactcenterinsightsV1LossPattern": { +"description": "A loss pattern of a virtual agent and suggested fixes.", +"id": "GoogleCloudContactcenterinsightsV1LossPattern", "properties": { -"assessmentNote": { -"$ref": "GoogleCloudContactcenterinsightsV1NoteAssessmentNote", -"description": "The note is associated to the entire parent assessment." -}, -"content": { -"description": "The note content.", +"conversationIds": { +"description": "Output only. A list of conversation IDs that match this loss pattern.", +"items": { "type": "string" }, -"conversationTurnNote": { -"$ref": "GoogleCloudContactcenterinsightsV1NoteConversationTurnNote", -"description": "The note is associated with a conversation turn." +"readOnly": true, +"type": "array" }, -"createTime": { -"description": "Output only. The time at which the note was created.", -"format": "google-datetime", +"description": { +"description": "Output only. A markdown description of the loss pattern.", "readOnly": true, "type": "string" }, -"name": { -"description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", +"displayName": { +"description": "Output only. The display name of the loss pattern.", +"readOnly": true, "type": "string" }, -"noteCreator": { -"$ref": "GoogleCloudContactcenterinsightsV1UserInfo", -"description": "Output only. The user that created the note.", -"readOnly": true +"examples": { +"description": "Output only. A markdown of loss pattern examples.", +"readOnly": true, +"type": "string" }, -"qaQuestionNote": { -"$ref": "GoogleCloudContactcenterinsightsV1NoteQaQuestionNote", -"description": "The note is associated with a QA question in one of the conversation's scorecard results." +"id": { +"description": "Output only. The unique identifier for the loss pattern.", +"readOnly": true, +"type": "string" }, -"updateTime": { -"description": "Output only. The time at which the note was last updated.", -"format": "google-datetime", +"percentage": { +"description": "Output only. The percentage of conversations that match this loss pattern.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"suggestedFixes": { +"description": "Output only. A markdown description of the suggested fixes.", "readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1NoteAssessmentNote": { -"description": "A note about the entire parent assessment.", -"id": "GoogleCloudContactcenterinsightsV1NoteAssessmentNote", -"properties": {}, -"type": "object" -}, -"GoogleCloudContactcenterinsightsV1NoteConversationTurnNote": { -"description": "A note about a conversation turn.", -"id": "GoogleCloudContactcenterinsightsV1NoteConversationTurnNote", +"GoogleCloudContactcenterinsightsV1MetricDefinition": { +"description": "A definition for a metric to be calculated during analysis.", +"id": "GoogleCloudContactcenterinsightsV1MetricDefinition", "properties": { -"turnIndex": { -"description": "The conversation turn index that the note is associated with.", -"format": "int32", -"type": "integer" +"displayName": { +"description": "Output only. The user-visible name of the metric (e.g., \"Containment Rate\").", +"readOnly": true, +"type": "string" +}, +"sourceId": { +"description": "Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.", +"readOnly": true, +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1NoteQaQuestionNote": { -"description": "A note about a QA question.", -"id": "GoogleCloudContactcenterinsightsV1NoteQaQuestionNote", +"GoogleCloudContactcenterinsightsV1MetricValue": { +"deprecated": true, +"description": "Deprecated: MetricValue is no longer used for diagnostics.", +"id": "GoogleCloudContactcenterinsightsV1MetricValue", +"properties": { +"conversations": { +"description": "Output only. The list of conversation names that contributed to this metric (hits). Format: `projects/{project}/locations/{location}/conversations/{conversation}`", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"displayName": { +"description": "Output only. The user-visible name of the metric (e.g., \"Containment Rate\").", +"readOnly": true, +"type": "string" +}, +"hitCount": { +"description": "Output only. The number of positive matches (hits) for this metric.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"metricType": { +"description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.", +"enum": [ +"METRIC_TYPE_UNSPECIFIED", +"ESCALATION", +"CONTAINMENT" +], +"enumDescriptions": [ +"Metric type is unspecified.", +"Escalation rate.", +"Containment rate." +], +"readOnly": true, +"type": "string" +}, +"sourceId": { +"description": "Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.", +"readOnly": true, +"type": "string" +}, +"totalCount": { +"description": "Output only. The total number of items evaluated for this metric.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"value": { +"description": "Output only. The calculated value of the metric (usually a ratio or rate 0.0 - 1.0).", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1Note": { +"description": "The conversation assessment note resource.", +"id": "GoogleCloudContactcenterinsightsV1Note", +"properties": { +"assessmentNote": { +"$ref": "GoogleCloudContactcenterinsightsV1NoteAssessmentNote", +"description": "The note is associated to the entire parent assessment." +}, +"content": { +"description": "The note content.", +"type": "string" +}, +"conversationTurnNote": { +"$ref": "GoogleCloudContactcenterinsightsV1NoteConversationTurnNote", +"description": "The note is associated with a conversation turn." +}, +"createTime": { +"description": "Output only. The time at which the note was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", +"type": "string" +}, +"noteCreator": { +"$ref": "GoogleCloudContactcenterinsightsV1UserInfo", +"description": "Output only. The user that created the note.", +"readOnly": true +}, +"qaQuestionNote": { +"$ref": "GoogleCloudContactcenterinsightsV1NoteQaQuestionNote", +"description": "The note is associated with a QA question in one of the conversation's scorecard results." +}, +"updateTime": { +"description": "Output only. The time at which the note was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1NoteAssessmentNote": { +"description": "A note about the entire parent assessment.", +"id": "GoogleCloudContactcenterinsightsV1NoteAssessmentNote", +"properties": {}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1NoteConversationTurnNote": { +"description": "A note about a conversation turn.", +"id": "GoogleCloudContactcenterinsightsV1NoteConversationTurnNote", +"properties": { +"turnIndex": { +"description": "The conversation turn index that the note is associated with.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1NoteQaQuestionNote": { +"description": "A note about a QA question.", +"id": "GoogleCloudContactcenterinsightsV1NoteQaQuestionNote", "properties": { "qaQuestion": { "description": "The question resource that the note is associated with.", @@ -10808,6 +11642,70 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1OutputConfig": { +"description": "Configuration for where to export or return the analysis findings.", +"id": "GoogleCloudContactcenterinsightsV1OutputConfig", +"properties": { +"bigqueryDestination": { +"$ref": "GoogleCloudContactcenterinsightsV1OutputConfigBigQueryDestination", +"description": "Optional. Export to BigQuery." +}, +"gcsDestination": { +"$ref": "GoogleCloudContactcenterinsightsV1OutputConfigGcsDestination", +"description": "Optional. Export to a Cloud Storage bucket." +}, +"googleSheetsDestination": { +"$ref": "GoogleCloudContactcenterinsightsV1OutputConfigGoogleSheetsDestination", +"description": "Optional. Export directly to a Google Sheet." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1OutputConfigBigQueryDestination": { +"description": "BigQuery destination configuration.", +"id": "GoogleCloudContactcenterinsightsV1OutputConfigBigQueryDestination", +"properties": { +"dataset": { +"description": "Required. The name of the BigQuery dataset.", +"type": "string" +}, +"projectId": { +"description": "Optional. A project ID or number.", +"type": "string" +}, +"table": { +"description": "Required. The BigQuery table name.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1OutputConfigGcsDestination": { +"description": "Cloud Storage destination configuration.", +"id": "GoogleCloudContactcenterinsightsV1OutputConfigGcsDestination", +"properties": { +"uri": { +"description": "Required. The Cloud Storage URI to export the results to.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1OutputConfigGoogleSheetsDestination": { +"description": "Google Sheets destination configuration.", +"id": "GoogleCloudContactcenterinsightsV1OutputConfigGoogleSheetsDestination", +"properties": { +"sheet": { +"description": "Optional. The sheet name.", +"type": "string" +}, +"spreadsheetId": { +"description": "Optional. An existing Google Sheets ID.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1PhraseMatchData": { "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "id": "GoogleCloudContactcenterinsightsV1PhraseMatchData", @@ -12175,6 +13073,14 @@ true "$ref": "GoogleCloudContactcenterinsightsV1ArticleSuggestionData", "description": "Agent Assist Article Suggestion data." }, +"cesEndSessionAnnotation": { +"$ref": "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation", +"description": "The CES end session annotation." +}, +"cesTurnAnnotation": { +"$ref": "GoogleCloudContactcenterinsightsV1CesTurnAnnotation", +"description": "The CES turn annotation." +}, "conversationSummarizationSuggestion": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData", "description": "Conversation summarization suggestion data." @@ -12429,6 +13335,10 @@ true "readOnly": true, "type": "string" }, +"diagnosticMetricConfig": { +"$ref": "GoogleCloudContactcenterinsightsV1SettingsDiagnosticMetricConfig", +"description": "Optional. Configuration for diagnostic metrics." +}, "languageCode": { "description": "A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to \"en-US\" if it is neither specified on the segment nor here.", "type": "string" @@ -12490,6 +13400,57 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1SettingsDiagnosticMetricConfig": { +"description": "Configuration for diagnostic metrics.", +"id": "GoogleCloudContactcenterinsightsV1SettingsDiagnosticMetricConfig", +"properties": { +"metrics": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1MetricDefinition" +}, +"description": "Optional. A map of diagnostic metrics. The key is a unique identifier for the metric (e.g., \"containment\").", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1SherlockStep": { +"description": "A step in the agent's reasoning process (Trajectory Step).", +"id": "GoogleCloudContactcenterinsightsV1SherlockStep", +"properties": { +"textInput": { +"description": "Output only. Natural language input stimulus.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"thought": { +"description": "Output only. The reasoning or internal monologue of the agent.", +"readOnly": true, +"type": "string" +}, +"toolCalls": { +"description": "Output only. The tool call issued by the agent.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1ToolCall" +}, +"readOnly": true, +"type": "array" +}, +"toolOutput": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Output only. The output response from the tool execution.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1SignedAudioUris": { "description": "Signed audio URIs for a conversation.", "id": "GoogleCloudContactcenterinsightsV1SignedAudioUris", @@ -12762,6 +13723,27 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1ToolCall": { +"description": "A tool call from the agent.", +"id": "GoogleCloudContactcenterinsightsV1ToolCall", +"properties": { +"input": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Output only. The input arguments to the tool.", +"readOnly": true, +"type": "object" +}, +"toolName": { +"description": "Output only. The name of the tool being called.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest": { "description": "Request for TuneQaScorecardRevision endpoint.", "id": "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest", @@ -13549,6 +14531,35 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation": { +"description": "The CES end session annotation.", +"id": "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation", +"properties": { +"endSession": { +"$ref": "GoogleCloudCesV1mainEndSession", +"description": "End session signal from CES." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation": { +"description": "The CES diagnostic information.", +"id": "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation", +"properties": { +"messages": { +"description": "The messages in the turn.", +"items": { +"$ref": "GoogleCloudCesV1mainMessage" +}, +"type": "array" +}, +"rootSpan": { +"$ref": "GoogleCloudCesV1mainSpan", +"description": "The root span of the action processing." +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult": { "description": "The result of testing a constraint expression on a pair of conversations.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult", @@ -14453,6 +15464,245 @@ true "properties": {}, "type": "object" }, +"GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsMetadata": { +"description": "Metadata for a DiagnoseConversations operation.", +"id": "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsMetadata", +"properties": { +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"diagnosticReport": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReport", +"description": "Output only. The diagnostic report containing metrics and intent breakdowns.", +"readOnly": true +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"fullReport": { +"description": "Output only. If true, the agent generated a full diagnostic report for all sub-agents.", +"readOnly": true, +"type": "boolean" +}, +"latestStep": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1SherlockStep", +"description": "Output only. The most recent thought or action from the agent.", +"readOnly": true +}, +"metricType": { +"description": "Output only. The type of metric being diagnosed.", +"enum": [ +"DIAGNOSTIC_METRIC_TYPE_UNSPECIFIED", +"ESCALATION", +"CONTAINMENT" +], +"enumDescriptions": [ +"Metric type is unspecified.", +"Escalation rate.", +"Containment rate." +], +"readOnly": true, +"type": "string" +}, +"partialTrajectories": { +"deprecated": true, +"description": "Output only. Deprecated: Use partial_trajectory_steps instead. The intermediate trajectory updates (partial trajectory).", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"partialTrajectorySteps": { +"description": "Output only. The intermediate trajectory updates. This can be used for live progress tracking of the agent's thoughts and actions as it works through the analysis.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1SherlockStep" +}, +"readOnly": true, +"type": "array" +}, +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsRequest", +"description": "Output only. The request that created the operation.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsRequest": { +"description": "The request to analyze conversation data using agentic workflows. This RPC triggers a complex analysis process that may involve several steps of reasoning and tool execution.", +"id": "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsRequest", +"properties": { +"dryRun": { +"description": "Optional. If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task.", +"type": "boolean" +}, +"filter": { +"description": "Optional. AIP-160 compliant filter for selecting target conversations.", +"type": "string" +}, +"fullReport": { +"description": "Optional. If true, the agent will generate a full diagnostic report for all sub-agents.", +"type": "boolean" +}, +"instructions": { +"description": "Optional. Specific instructions for the agent.", +"type": "string" +}, +"maxSteps": { +"description": "Optional. The maximum number of steps the agent can take during the execution of the task. Defaults to 10.", +"format": "int32", +"type": "integer" +}, +"metricType": { +"description": "Optional. The type of metric being diagnosed.", +"enum": [ +"DIAGNOSTIC_METRIC_TYPE_UNSPECIFIED", +"ESCALATION", +"CONTAINMENT" +], +"enumDescriptions": [ +"Metric type is unspecified.", +"Escalation rate.", +"Containment rate." +], +"type": "string" +}, +"outputConfig": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1OutputConfig", +"description": "Optional. The configuration for the output of the task." +}, +"parent": { +"description": "Required. The parent resource where the analysis will be performed.", +"type": "string" +}, +"requestId": { +"description": "Optional. Required. A unique ID that identifies the request. If the service receives two `DiagnoseConversationsRequest`s with the same `request_id`, then the second request will be ignored; instead, the response of the first request will be returned. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", +"type": "string" +}, +"taskQuery": { +"description": "Optional. A natural language description of the analysis goal or question.", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If true, the request will only be validated (permissions, filter syntax, etc.) without actually triggering the analysis.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsResponse": { +"description": "The response from a DiagnoseConversations request.", +"id": "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsResponse", +"properties": { +"answer": { +"description": "Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker.", +"readOnly": true, +"type": "string" +}, +"exportUri": { +"description": "Output only. If an external destination was requested, the URI of the exported data.", +"readOnly": true, +"type": "string" +}, +"fullTrajectories": { +"deprecated": true, +"description": "Output only. Deprecated: Use full_trajectory_steps instead. The complete sequence of thoughts and actions (full trajectory).", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"fullTrajectorySteps": { +"description": "Output only. The complete sequence of thoughts and actions taken by the agent.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1SherlockStep" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1DiagnosticReport": { +"description": "A diagnostic report containing aggregate metrics and intent breakdowns.", +"id": "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReport", +"properties": { +"intentStats": { +"description": "Output only. A breakdown of metrics grouped by intent.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReportIntentStats" +}, +"readOnly": true, +"type": "array" +}, +"lossPatterns": { +"description": "Output only. A list of loss patterns identified for the entire project/dataset.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1LossPattern" +}, +"readOnly": true, +"type": "array" +}, +"metrics": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1MetricValue" +}, +"deprecated": true, +"description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1DiagnosticReportIntentStats": { +"description": "A breakdown of metrics grouped by intent.", +"id": "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReportIntentStats", +"properties": { +"conversationCount": { +"description": "Output only. The number of conversations associated with this intent.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"intentDisplayName": { +"description": "Output only. The display name of the intent.", +"readOnly": true, +"type": "string" +}, +"intentId": { +"description": "Output only. The unique identifier for the intent (from Discovery Engine).", +"readOnly": true, +"type": "string" +}, +"lossPatterns": { +"description": "Output only. A list of loss patterns identified for this intent.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1LossPattern" +}, +"readOnly": true, +"type": "array" +}, +"metrics": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1MetricValue" +}, +"deprecated": true, +"description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent": { "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent", @@ -16036,19 +17286,188 @@ true }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse": { -"description": "The response for listing feedback labels.", -"id": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse", +"GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse": { +"description": "The response for listing feedback labels.", +"id": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse", +"properties": { +"feedbackLabels": { +"description": "The feedback labels that match the request.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The next page token.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1LossPattern": { +"description": "A loss pattern of a virtual agent and suggested fixes.", +"id": "GoogleCloudContactcenterinsightsV1alpha1LossPattern", +"properties": { +"conversationIds": { +"description": "Output only. A list of conversation IDs that match this loss pattern.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"description": { +"description": "Output only. A markdown description of the loss pattern.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The display name of the loss pattern.", +"readOnly": true, +"type": "string" +}, +"examples": { +"description": "Output only. A markdown of loss pattern examples.", +"readOnly": true, +"type": "string" +}, +"id": { +"description": "Output only. The unique identifier for the loss pattern.", +"readOnly": true, +"type": "string" +}, +"percentage": { +"description": "Output only. The percentage of conversations that match this loss pattern.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"suggestedFixes": { +"description": "Output only. A markdown description of the suggested fixes.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1MetricValue": { +"deprecated": true, +"description": "Deprecated: MetricValue is no longer used for diagnostics.", +"id": "GoogleCloudContactcenterinsightsV1alpha1MetricValue", +"properties": { +"conversations": { +"description": "Output only. The list of conversation names that contributed to this metric (hits). Format: `projects/{project}/locations/{location}/conversations/{conversation}`", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"displayName": { +"description": "Output only. The user-visible name of the metric (e.g., \"Containment Rate\").", +"readOnly": true, +"type": "string" +}, +"hitCount": { +"description": "Output only. The number of positive matches (hits) for this metric.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"metricType": { +"description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.", +"enum": [ +"METRIC_TYPE_UNSPECIFIED", +"ESCALATION", +"CONTAINMENT" +], +"enumDescriptions": [ +"Metric type is unspecified.", +"Escalation rate.", +"Containment rate." +], +"readOnly": true, +"type": "string" +}, +"sourceId": { +"description": "Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.", +"readOnly": true, +"type": "string" +}, +"totalCount": { +"description": "Output only. The total number of items evaluated for this metric.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"value": { +"description": "Output only. The calculated value of the metric (usually a ratio or rate 0.0 - 1.0).", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1OutputConfig": { +"description": "Configuration for where to export or return the analysis findings.", +"id": "GoogleCloudContactcenterinsightsV1alpha1OutputConfig", +"properties": { +"bigqueryDestination": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1OutputConfigBigQueryDestination", +"description": "Optional. Export to BigQuery." +}, +"gcsDestination": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1OutputConfigGcsDestination", +"description": "Optional. Export to a Cloud Storage bucket." +}, +"googleSheetsDestination": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1OutputConfigGoogleSheetsDestination", +"description": "Optional. Export directly to a Google Sheet." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1OutputConfigBigQueryDestination": { +"description": "BigQuery destination configuration.", +"id": "GoogleCloudContactcenterinsightsV1alpha1OutputConfigBigQueryDestination", +"properties": { +"dataset": { +"description": "Required. The name of the BigQuery dataset.", +"type": "string" +}, +"projectId": { +"description": "Optional. A project ID or number.", +"type": "string" +}, +"table": { +"description": "Required. The BigQuery table name.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1OutputConfigGcsDestination": { +"description": "Cloud Storage destination configuration.", +"id": "GoogleCloudContactcenterinsightsV1alpha1OutputConfigGcsDestination", "properties": { -"feedbackLabels": { -"description": "The feedback labels that match the request.", -"items": { -"$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" +"uri": { +"description": "Required. The Cloud Storage URI to export the results to.", +"type": "string" +} }, -"type": "array" +"type": "object" }, -"nextPageToken": { -"description": "The next page token.", +"GoogleCloudContactcenterinsightsV1alpha1OutputConfigGoogleSheetsDestination": { +"description": "Google Sheets destination configuration.", +"id": "GoogleCloudContactcenterinsightsV1alpha1OutputConfigGoogleSheetsDestination", +"properties": { +"sheet": { +"description": "Optional. The sheet name.", +"type": "string" +}, +"spreadsheetId": { +"description": "Optional. An existing Google Sheets ID.", "type": "string" } }, @@ -16840,6 +18259,14 @@ true "$ref": "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData", "description": "Agent Assist Article Suggestion data." }, +"cesEndSessionAnnotation": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation", +"description": "The CES end session annotation." +}, +"cesTurnAnnotation": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation", +"description": "The CES turn annotation." +}, "conversationSummarizationSuggestion": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData", "description": "Conversation summarization suggestion data." @@ -17032,6 +18459,43 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1alpha1SherlockStep": { +"description": "A step in the agent's reasoning process (Trajectory Step).", +"id": "GoogleCloudContactcenterinsightsV1alpha1SherlockStep", +"properties": { +"textInput": { +"description": "Output only. Natural language input stimulus.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"thought": { +"description": "Output only. The reasoning or internal monologue of the agent.", +"readOnly": true, +"type": "string" +}, +"toolCalls": { +"description": "Output only. The tool call issued by the agent.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1ToolCall" +}, +"readOnly": true, +"type": "array" +}, +"toolOutput": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Output only. The output response from the tool execution.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1alpha1SilenceData": { "description": "The data for a silence annotation.", "id": "GoogleCloudContactcenterinsightsV1alpha1SilenceData", @@ -17218,6 +18682,27 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1alpha1ToolCall": { +"description": "A tool call from the agent.", +"id": "GoogleCloudContactcenterinsightsV1alpha1ToolCall", +"properties": { +"input": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Output only. The input arguments to the tool.", +"readOnly": true, +"type": "object" +}, +"toolName": { +"description": "Output only. The name of the tool being called.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata": { "description": "Metadata for undeploying an issue model.", "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata", @@ -18099,6 +19584,35 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation": { +"description": "The CES end session annotation.", +"id": "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation", +"properties": { +"endSession": { +"$ref": "GoogleCloudCesV1mainEndSession", +"description": "End session signal from CES." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation": { +"description": "The CES diagnostic information.", +"id": "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation", +"properties": { +"messages": { +"description": "The messages in the turn.", +"items": { +"$ref": "GoogleCloudCesV1mainMessage" +}, +"type": "array" +}, +"rootSpan": { +"$ref": "GoogleCloudCesV1mainSpan", +"description": "The root span of the action processing." +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult": { "description": "The result of testing a constraint expression on a pair of conversations.", "id": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult", @@ -18894,113 +20408,352 @@ true }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata": { -"description": "Metadata for deleting an issue model.", -"id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata", +"GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata": { +"description": "Metadata for deleting an issue model.", +"id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata", +"properties": { +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest", +"description": "The original request for deletion." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest": { +"description": "The request to delete an issue model.", +"id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest", +"properties": { +"name": { +"description": "Required. The name of the issue model to delete.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata": { +"description": "The metadata for deleting a QaQuestionTag Resource.", +"id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata", +"properties": { +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest", +"description": "Output only. The original request.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest": { +"description": "The request for deleting a QaQuestionTag.", +"id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest", +"properties": { +"name": { +"description": "Required. The name of the QaQuestionTag to delete.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata": { +"description": "Metadata for deploying an issue model.", +"id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata", +"properties": { +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest", +"description": "The original request for deployment." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest": { +"description": "The request to deploy an issue model.", +"id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest", +"properties": { +"name": { +"description": "Required. The issue model to deploy.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse": { +"description": "The response to deploy an issue model.", +"id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsMetadata": { +"description": "Metadata for a DiagnoseConversations operation.", +"id": "GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsMetadata", +"properties": { +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"diagnosticReport": { +"$ref": "GoogleCloudContactcenterinsightsV1mainDiagnosticReport", +"description": "Output only. The diagnostic report containing metrics and intent breakdowns.", +"readOnly": true +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"fullReport": { +"description": "Output only. If true, the agent generated a full diagnostic report for all sub-agents.", +"readOnly": true, +"type": "boolean" +}, +"latestStep": { +"$ref": "GoogleCloudContactcenterinsightsV1mainSherlockStep", +"description": "Output only. The most recent thought or action from the agent.", +"readOnly": true +}, +"metricType": { +"description": "Output only. The type of metric being diagnosed.", +"enum": [ +"DIAGNOSTIC_METRIC_TYPE_UNSPECIFIED", +"ESCALATION", +"CONTAINMENT" +], +"enumDescriptions": [ +"Metric type is unspecified.", +"Escalation rate.", +"Containment rate." +], +"readOnly": true, +"type": "string" +}, +"partialTrajectories": { +"deprecated": true, +"description": "Output only. Deprecated: Use partial_trajectory_steps instead. The intermediate trajectory updates (partial trajectory).", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"partialTrajectorySteps": { +"description": "Output only. The intermediate trajectory updates. This can be used for live progress tracking of the agent's thoughts and actions as it works through the analysis.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1mainSherlockStep" +}, +"readOnly": true, +"type": "array" +}, +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsRequest", +"description": "Output only. The request that created the operation.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsRequest": { +"description": "The request to analyze conversation data using agentic workflows. This RPC triggers a complex analysis process that may involve several steps of reasoning and tool execution.", +"id": "GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsRequest", +"properties": { +"dryRun": { +"description": "Optional. If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task.", +"type": "boolean" +}, +"filter": { +"description": "Optional. AIP-160 compliant filter for selecting target conversations.", +"type": "string" +}, +"fullReport": { +"description": "Optional. If true, the agent will generate a full diagnostic report for all sub-agents.", +"type": "boolean" +}, +"instructions": { +"description": "Optional. Specific instructions for the agent.", +"type": "string" +}, +"maxSteps": { +"description": "Optional. The maximum number of steps the agent can take during the execution of the task. Defaults to 10.", +"format": "int32", +"type": "integer" +}, +"metricType": { +"description": "Optional. The type of metric being diagnosed.", +"enum": [ +"DIAGNOSTIC_METRIC_TYPE_UNSPECIFIED", +"ESCALATION", +"CONTAINMENT" +], +"enumDescriptions": [ +"Metric type is unspecified.", +"Escalation rate.", +"Containment rate." +], +"type": "string" +}, +"outputConfig": { +"$ref": "GoogleCloudContactcenterinsightsV1mainOutputConfig", +"description": "Optional. The configuration for the output of the task." +}, +"parent": { +"description": "Required. The parent resource where the analysis will be performed.", +"type": "string" +}, +"requestId": { +"description": "Optional. Required. A unique ID that identifies the request. If the service receives two `DiagnoseConversationsRequest`s with the same `request_id`, then the second request will be ignored; instead, the response of the first request will be returned. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", +"type": "string" +}, +"taskQuery": { +"description": "Optional. A natural language description of the analysis goal or question.", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If true, the request will only be validated (permissions, filter syntax, etc.) without actually triggering the analysis.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsResponse": { +"description": "The response from a DiagnoseConversations request.", +"id": "GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsResponse", "properties": { -"createTime": { -"description": "Output only. The time the operation was created.", -"format": "google-datetime", +"answer": { +"description": "Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker.", "readOnly": true, "type": "string" }, -"endTime": { -"description": "Output only. The time the operation finished running.", -"format": "google-datetime", +"exportUri": { +"description": "Output only. If an external destination was requested, the URI of the exported data.", "readOnly": true, "type": "string" }, -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest", -"description": "The original request for deletion." -} +"fullTrajectories": { +"deprecated": true, +"description": "Output only. Deprecated: Use full_trajectory_steps instead. The complete sequence of thoughts and actions (full trajectory).", +"items": { +"type": "string" }, -"type": "object" +"readOnly": true, +"type": "array" }, -"GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest": { -"description": "The request to delete an issue model.", -"id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest", -"properties": { -"name": { -"description": "Required. The name of the issue model to delete.", -"type": "string" +"fullTrajectorySteps": { +"description": "Output only. The complete sequence of thoughts and actions taken by the agent.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1mainSherlockStep" +}, +"readOnly": true, +"type": "array" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata": { -"description": "The metadata for deleting a QaQuestionTag Resource.", -"id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata", +"GoogleCloudContactcenterinsightsV1mainDiagnosticReport": { +"description": "A diagnostic report containing aggregate metrics and intent breakdowns.", +"id": "GoogleCloudContactcenterinsightsV1mainDiagnosticReport", "properties": { -"createTime": { -"description": "Output only. The time the operation was created.", -"format": "google-datetime", +"intentStats": { +"description": "Output only. A breakdown of metrics grouped by intent.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1mainDiagnosticReportIntentStats" +}, "readOnly": true, -"type": "string" +"type": "array" +}, +"lossPatterns": { +"description": "Output only. A list of loss patterns identified for the entire project/dataset.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1mainLossPattern" }, -"endTime": { -"description": "Output only. The time the operation finished running.", -"format": "google-datetime", "readOnly": true, -"type": "string" +"type": "array" }, -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest", -"description": "Output only. The original request.", -"readOnly": true -} +"metrics": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1mainMetricValue" }, +"deprecated": true, +"description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.", +"readOnly": true, "type": "object" -}, -"GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest": { -"description": "The request for deleting a QaQuestionTag.", -"id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest", -"properties": { -"name": { -"description": "Required. The name of the QaQuestionTag to delete.", -"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata": { -"description": "Metadata for deploying an issue model.", -"id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata", +"GoogleCloudContactcenterinsightsV1mainDiagnosticReportIntentStats": { +"description": "A breakdown of metrics grouped by intent.", +"id": "GoogleCloudContactcenterinsightsV1mainDiagnosticReportIntentStats", "properties": { -"createTime": { -"description": "Output only. The time the operation was created.", -"format": "google-datetime", +"conversationCount": { +"description": "Output only. The number of conversations associated with this intent.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"intentDisplayName": { +"description": "Output only. The display name of the intent.", "readOnly": true, "type": "string" }, -"endTime": { -"description": "Output only. The time the operation finished running.", -"format": "google-datetime", +"intentId": { +"description": "Output only. The unique identifier for the intent (from Discovery Engine).", "readOnly": true, "type": "string" }, -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest", -"description": "The original request for deployment." -} +"lossPatterns": { +"description": "Output only. A list of loss patterns identified for this intent.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1mainLossPattern" }, -"type": "object" +"readOnly": true, +"type": "array" }, -"GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest": { -"description": "The request to deploy an issue model.", -"id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest", -"properties": { -"name": { -"description": "Required. The issue model to deploy.", -"type": "string" -} +"metrics": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1mainMetricValue" }, +"deprecated": true, +"description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.", +"readOnly": true, "type": "object" +} }, -"GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse": { -"description": "The response to deploy an issue model.", -"id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse", -"properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDialogflowIntent": { @@ -20604,6 +22357,175 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1mainLossPattern": { +"description": "A loss pattern of a virtual agent and suggested fixes.", +"id": "GoogleCloudContactcenterinsightsV1mainLossPattern", +"properties": { +"conversationIds": { +"description": "Output only. A list of conversation IDs that match this loss pattern.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"description": { +"description": "Output only. A markdown description of the loss pattern.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The display name of the loss pattern.", +"readOnly": true, +"type": "string" +}, +"examples": { +"description": "Output only. A markdown of loss pattern examples.", +"readOnly": true, +"type": "string" +}, +"id": { +"description": "Output only. The unique identifier for the loss pattern.", +"readOnly": true, +"type": "string" +}, +"percentage": { +"description": "Output only. The percentage of conversations that match this loss pattern.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"suggestedFixes": { +"description": "Output only. A markdown description of the suggested fixes.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainMetricValue": { +"deprecated": true, +"description": "Deprecated: MetricValue is no longer used for diagnostics.", +"id": "GoogleCloudContactcenterinsightsV1mainMetricValue", +"properties": { +"conversations": { +"description": "Output only. The list of conversation names that contributed to this metric (hits). Format: `projects/{project}/locations/{location}/conversations/{conversation}`", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"displayName": { +"description": "Output only. The user-visible name of the metric (e.g., \"Containment Rate\").", +"readOnly": true, +"type": "string" +}, +"hitCount": { +"description": "Output only. The number of positive matches (hits) for this metric.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"metricType": { +"description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.", +"enum": [ +"METRIC_TYPE_UNSPECIFIED", +"ESCALATION", +"CONTAINMENT" +], +"enumDescriptions": [ +"Metric type is unspecified.", +"Escalation rate.", +"Containment rate." +], +"readOnly": true, +"type": "string" +}, +"sourceId": { +"description": "Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.", +"readOnly": true, +"type": "string" +}, +"totalCount": { +"description": "Output only. The total number of items evaluated for this metric.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"value": { +"description": "Output only. The calculated value of the metric (usually a ratio or rate 0.0 - 1.0).", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainOutputConfig": { +"description": "Configuration for where to export or return the analysis findings.", +"id": "GoogleCloudContactcenterinsightsV1mainOutputConfig", +"properties": { +"bigqueryDestination": { +"$ref": "GoogleCloudContactcenterinsightsV1mainOutputConfigBigQueryDestination", +"description": "Optional. Export to BigQuery." +}, +"gcsDestination": { +"$ref": "GoogleCloudContactcenterinsightsV1mainOutputConfigGcsDestination", +"description": "Optional. Export to a Cloud Storage bucket." +}, +"googleSheetsDestination": { +"$ref": "GoogleCloudContactcenterinsightsV1mainOutputConfigGoogleSheetsDestination", +"description": "Optional. Export directly to a Google Sheet." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainOutputConfigBigQueryDestination": { +"description": "BigQuery destination configuration.", +"id": "GoogleCloudContactcenterinsightsV1mainOutputConfigBigQueryDestination", +"properties": { +"dataset": { +"description": "Required. The name of the BigQuery dataset.", +"type": "string" +}, +"projectId": { +"description": "Optional. A project ID or number.", +"type": "string" +}, +"table": { +"description": "Required. The BigQuery table name.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainOutputConfigGcsDestination": { +"description": "Cloud Storage destination configuration.", +"id": "GoogleCloudContactcenterinsightsV1mainOutputConfigGcsDestination", +"properties": { +"uri": { +"description": "Required. The Cloud Storage URI to export the results to.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainOutputConfigGoogleSheetsDestination": { +"description": "Google Sheets destination configuration.", +"id": "GoogleCloudContactcenterinsightsV1mainOutputConfigGoogleSheetsDestination", +"properties": { +"sheet": { +"description": "Optional. The sheet name.", +"type": "string" +}, +"spreadsheetId": { +"description": "Optional. An existing Google Sheets ID.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1mainPhraseMatchData": { "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "id": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData", @@ -21390,6 +23312,14 @@ true "$ref": "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData", "description": "Agent Assist Article Suggestion data." }, +"cesEndSessionAnnotation": { +"$ref": "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation", +"description": "The CES end session annotation." +}, +"cesTurnAnnotation": { +"$ref": "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation", +"description": "The CES turn annotation." +}, "conversationSummarizationSuggestion": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData", "description": "Conversation summarization suggestion data." @@ -21582,6 +23512,43 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1mainSherlockStep": { +"description": "A step in the agent's reasoning process (Trajectory Step).", +"id": "GoogleCloudContactcenterinsightsV1mainSherlockStep", +"properties": { +"textInput": { +"description": "Output only. Natural language input stimulus.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"thought": { +"description": "Output only. The reasoning or internal monologue of the agent.", +"readOnly": true, +"type": "string" +}, +"toolCalls": { +"description": "Output only. The tool call issued by the agent.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1mainToolCall" +}, +"readOnly": true, +"type": "array" +}, +"toolOutput": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Output only. The output response from the tool execution.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1mainSilenceData": { "description": "The data for a silence annotation.", "id": "GoogleCloudContactcenterinsightsV1mainSilenceData", @@ -21768,6 +23735,27 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1mainToolCall": { +"description": "A tool call from the agent.", +"id": "GoogleCloudContactcenterinsightsV1mainToolCall", +"properties": { +"input": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Output only. The input arguments to the tool.", +"readOnly": true, +"type": "object" +}, +"toolName": { +"description": "Output only. The name of the tool being called.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata": { "description": "Metadata for undeploying an issue model.", "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata", From a4f720dc24d2e0b09626bc1a7580f049f2ec1bc0 Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 21 Apr 2026 07:41:55 +0000 Subject: [PATCH 07/18] feat(container): update the api #### container:v1 The following keys were added: - schemas.AddonsConfig.properties.slurmOperatorConfig.$ref (Total Keys: 1) - schemas.SlurmOperatorConfig (Total Keys: 3) #### container:v1beta1 The following keys were added: - schemas.AddonsConfig.properties.slurmOperatorConfig.$ref (Total Keys: 1) - schemas.SlurmOperatorConfig (Total Keys: 3) --- ...ontainer_v1.projects.locations.clusters.html | 15 +++++++++++++++ .../container_v1.projects.zones.clusters.html | 15 +++++++++++++++ ...ner_v1beta1.projects.locations.clusters.html | 15 +++++++++++++++ ...ntainer_v1beta1.projects.zones.clusters.html | 15 +++++++++++++++ .../discovery_cache/documents/container.v1.json | 17 ++++++++++++++++- .../documents/container.v1beta1.json | 17 ++++++++++++++++- 6 files changed, 92 insertions(+), 2 deletions(-) diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index 099f73bbc2..018c34eafd 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -333,6 +333,9 @@ Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # When enabled, it runs a Slurm Operator that manages the set of compute pods for Slurm Cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -2019,6 +2022,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # When enabled, it runs a Slurm Operator that manages the set of compute pods for Slurm Cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -3569,6 +3575,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # When enabled, it runs a Slurm Operator that manages the set of compute pods for Slurm Cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -5079,6 +5088,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # When enabled, it runs a Slurm Operator that manages the set of compute pods for Slurm Cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -6002,6 +6014,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # When enabled, it runs a Slurm Operator that manages the set of compute pods for Slurm Cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index 57611bccb4..85bb5f2b34 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -210,6 +210,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # When enabled, it runs a Slurm Operator that manages the set of compute pods for Slurm Cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -438,6 +441,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # When enabled, it runs a Slurm Operator that manages the set of compute pods for Slurm Cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -2124,6 +2130,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # When enabled, it runs a Slurm Operator that manages the set of compute pods for Slurm Cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -3718,6 +3727,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # When enabled, it runs a Slurm Operator that manages the set of compute pods for Slurm Cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -6029,6 +6041,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # When enabled, it runs a Slurm Operator that manages the set of compute pods for Slurm Cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index ecb4eaba95..f62133ebfc 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -420,6 +420,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # Whether the Slurm Operator is enabled in the cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -2206,6 +2209,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # Whether the Slurm Operator is enabled in the cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -3849,6 +3855,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # Whether the Slurm Operator is enabled in the cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -5452,6 +5461,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # Whether the Slurm Operator is enabled in the cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -6385,6 +6397,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # Whether the Slurm Operator is enabled in the cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index 351c4951be..950e3e03ef 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -223,6 +223,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # Whether the Slurm Operator is enabled in the cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -535,6 +538,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # Whether the Slurm Operator is enabled in the cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -2321,6 +2327,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # Whether the Slurm Operator is enabled in the cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -4008,6 +4017,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # Whether the Slurm Operator is enabled in the cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, @@ -6412,6 +6424,9 @@Method Details
"sliceControllerConfig": { # Configuration for the Slice Controller. # Optional. Configuration for the slice controller add-on. "enabled": True or False, # Optional. Indicates whether Slice Controller is enabled in the cluster. }, + "slurmOperatorConfig": { # Configuration for the Slurm Operator. # Configuration for the Slurm Operator. + "enabled": True or False, # Whether the Slurm Operator is enabled in the cluster. + }, "statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on. "enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index 6d41a067ab..e2b7e00b49 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2660,7 +2660,7 @@ } } }, -"revision": "20260331", +"revision": "20260407", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2867,6 +2867,10 @@ "$ref": "SliceControllerConfig", "description": "Optional. Configuration for the slice controller add-on." }, +"slurmOperatorConfig": { +"$ref": "SlurmOperatorConfig", +"description": "Configuration for the Slurm Operator." +}, "statefulHaConfig": { "$ref": "StatefulHAConfig", "description": "Optional. Configuration for the StatefulHA add-on." @@ -9083,6 +9087,17 @@ false }, "type": "object" }, +"SlurmOperatorConfig": { +"description": "Configuration for the Slurm Operator.", +"id": "SlurmOperatorConfig", +"properties": { +"enabled": { +"description": "When enabled, it runs a Slurm Operator that manages the set of compute pods for Slurm Cluster.", +"type": "boolean" +} +}, +"type": "object" +}, "SoleTenantConfig": { "description": "SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool.", "id": "SoleTenantConfig", diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index a8c8a9a8a0..eb9f193a53 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2741,7 +2741,7 @@ } } }, -"revision": "20260331", +"revision": "20260407", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2968,6 +2968,10 @@ "$ref": "SliceControllerConfig", "description": "Optional. Configuration for the slice controller add-on." }, +"slurmOperatorConfig": { +"$ref": "SlurmOperatorConfig", +"description": "Configuration for the Slurm Operator." +}, "statefulHaConfig": { "$ref": "StatefulHAConfig", "description": "Optional. Configuration for the StatefulHA add-on." @@ -9733,6 +9737,17 @@ false }, "type": "object" }, +"SlurmOperatorConfig": { +"description": "Configuration for the Slurm Operator.", +"id": "SlurmOperatorConfig", +"properties": { +"enabled": { +"description": "Whether the Slurm Operator is enabled in the cluster.", +"type": "boolean" +} +}, +"type": "object" +}, "SoleTenantConfig": { "description": "SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool.", "id": "SoleTenantConfig", From a53b35f6175a74622e2ebb40c389a422a5ef1dbc Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 21 Apr 2026 07:41:55 +0000 Subject: [PATCH 08/18] fix(dataform): update the api #### dataform:v1 The following keys were changed: - endpoints (Total Keys: 1) #### dataform:v1beta1 The following keys were changed: - endpoints (Total Keys: 1) --- ...ataform_v1.projects.locations.folders.html | 20 +++++----- docs/dyn/dataform_v1.projects.locations.html | 10 ++--- ...rm_v1.projects.locations.repositories.html | 12 +++--- ...cts.locations.repositories.workspaces.html | 2 +- ...orm_v1.projects.locations.teamFolders.html | 14 +++---- ...rm_v1beta1.projects.locations.folders.html | 20 +++++----- .../dataform_v1beta1.projects.locations.html | 10 ++--- ...beta1.projects.locations.repositories.html | 12 +++--- ...cts.locations.repositories.workspaces.html | 2 +- ...1beta1.projects.locations.teamFolders.html | 14 +++---- .../documents/dataform.v1.json | 40 ++++++++++++------- .../documents/dataform.v1beta1.json | 40 ++++++++++++------- 12 files changed, 108 insertions(+), 88 deletions(-) diff --git a/docs/dyn/dataform_v1.projects.locations.folders.html b/docs/dyn/dataform_v1.projects.locations.folders.html index 0cfbc61ba0..fde514afb3 100644 --- a/docs/dyn/dataform_v1.projects.locations.folders.html +++ b/docs/dyn/dataform_v1.projects.locations.folders.html @@ -126,7 +126,7 @@ Method Details
The object takes the form of: { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -145,7 +145,7 @@Method Details
An object of the form: { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -231,7 +231,7 @@Method Details
An object of the form: { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -329,7 +329,7 @@Method Details
The object takes the form of: { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -349,7 +349,7 @@Method Details
An object of the form: { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -365,9 +365,9 @@Method Details
Returns the contents of a given Folder. Args: - folder: string, Required. Name of the folder whose contents to list. Format: projects/*/locations/*/folders/* (required) - filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""` - orderBy: string, Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples: - `orderBy="display_name"` - `orderBy="display_name desc"` + folder: string, Required. Resource name of the Folder to list contents for. Format: projects/*/locations/*/folders/* (required) + filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""` + orderBy: string, Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"` pageSize: integer, Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. pageToken: string, Optional. Page token received from a previous `QueryFolderContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryFolderContents`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. @@ -382,7 +382,7 @@Method Details
"entries": [ # List of entries in the folder. { # Represents a single content entry. "folder": { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. # A subfolder. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -400,7 +400,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. diff --git a/docs/dyn/dataform_v1.projects.locations.html b/docs/dyn/dataform_v1.projects.locations.html index 522f1d4dd0..3db9459fde 100644 --- a/docs/dyn/dataform_v1.projects.locations.html +++ b/docs/dyn/dataform_v1.projects.locations.html @@ -227,9 +227,9 @@Method Details
Returns the contents of a caller's root folder in a given location. The root folder contains all resources that are created by the user and not contained in any other folder. Args: - location: string, Required. Location of the user root folder whose contents to list. Format: projects/*/locations/* (required) - filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""` - orderBy: string, Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), created_at, last_modified_at. Examples: - `orderBy="display_name"` - `orderBy="display_name desc"` + location: string, Required. Location of the user root folder to list contents for. Format: projects/*/locations/* (required) + filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""` + orderBy: string, Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), created_at, last_modified_at. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"` pageSize: integer, Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. pageToken: string, Optional. Page token received from a previous `QueryUserRootContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryUserRootFolderContents`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. @@ -244,7 +244,7 @@Method Details
"entries": [ # List of entries in the folder. { # Represents a single content entry. "folder": { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. # A subfolder. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -262,7 +262,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.html b/docs/dyn/dataform_v1.projects.locations.repositories.html index 77d20339ae..6f73a82a0a 100644 --- a/docs/dyn/dataform_v1.projects.locations.repositories.html +++ b/docs/dyn/dataform_v1.projects.locations.repositories.html @@ -241,7 +241,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -284,7 +284,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -419,7 +419,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -510,7 +510,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -615,7 +615,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -658,7 +658,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html b/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html index e7eb633e6a..b8dcbd64d2 100644 --- a/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html +++ b/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html @@ -607,7 +607,7 @@Method Details
path: string, Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used. view: string, Optional. Specifies the metadata to return for each directory entry. If unspecified, the default is `DIRECTORY_CONTENTS_VIEW_BASIC`. Currently the `DIRECTORY_CONTENTS_VIEW_METADATA` view is not supported by CMEK-protected workspaces. Allowed values - DIRECTORY_CONTENTS_VIEW_UNSPECIFIED - The default / unset value. Defaults to DIRECTORY_CONTENTS_VIEW_BASIC. + DIRECTORY_CONTENTS_VIEW_UNSPECIFIED - The default unset value. Defaults to DIRECTORY_CONTENTS_VIEW_BASIC. DIRECTORY_CONTENTS_VIEW_BASIC - Includes only the file or directory name. This is the default behavior. DIRECTORY_CONTENTS_VIEW_METADATA - Includes all metadata for each file or directory. Currently not supported by CMEK-protected workspaces. x__xgafv: string, V1 error format. diff --git a/docs/dyn/dataform_v1.projects.locations.teamFolders.html b/docs/dyn/dataform_v1.projects.locations.teamFolders.html index a289d4947f..8d388c465a 100644 --- a/docs/dyn/dataform_v1.projects.locations.teamFolders.html +++ b/docs/dyn/dataform_v1.projects.locations.teamFolders.html @@ -316,9 +316,9 @@Method Details
Returns the contents of a given TeamFolder. Args: - teamFolder: string, Required. Name of the team_folder whose contents to list. Format: `projects/*/locations/*/teamFolders/*`. (required) - filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""` - orderBy: string, Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: `display_name` (default), `create_time`, last_modified_time. Examples: - `orderBy="display_name"` - `orderBy="display_name desc"` + teamFolder: string, Required. Resource name of the TeamFolder to list contents for. Format: `projects/*/locations/*/teamFolders/*`. (required) + filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""` + orderBy: string, Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: `display_name` (default), `create_time`, last_modified_time. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"` pageSize: integer, Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. pageToken: string, Optional. Page token received from a previous `QueryTeamFolderContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryTeamFolderContents`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. @@ -333,7 +333,7 @@Method Details
"entries": [ # List of entries in the TeamFolder. { # Represents a single content entry. "folder": { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. # A subfolder. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -351,7 +351,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -401,8 +401,8 @@Method Details
Args: location: string, Required. Location in which to query TeamFolders. Format: `projects/*/locations/*`. (required) - filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""` - orderBy: string, Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples: - `orderBy="display_name"` - `orderBy="display_name desc"` + filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""` + orderBy: string, Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"` pageSize: integer, Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. pageToken: string, Optional. Page token received from a previous `SearchTeamFolders` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchTeamFolders`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.folders.html b/docs/dyn/dataform_v1beta1.projects.locations.folders.html index 49d7302548..1bf6634f0c 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.folders.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.folders.html @@ -126,7 +126,7 @@Method Details
The object takes the form of: { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -146,7 +146,7 @@Method Details
An object of the form: { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -232,7 +232,7 @@Method Details
An object of the form: { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -330,7 +330,7 @@Method Details
The object takes the form of: { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -350,7 +350,7 @@Method Details
An object of the form: { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -366,9 +366,9 @@Method Details
Returns the contents of a given Folder. Args: - folder: string, Required. Name of the folder whose contents to list. Format: projects/*/locations/*/folders/* (required) - filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""` - orderBy: string, Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples: - `orderBy="display_name"` - `orderBy="display_name desc"` + folder: string, Required. Resource name of the Folder to list contents for. Format: projects/*/locations/*/folders/* (required) + filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""` + orderBy: string, Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"` pageSize: integer, Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. pageToken: string, Optional. Page token received from a previous `QueryFolderContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryFolderContents`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. @@ -383,7 +383,7 @@Method Details
"entries": [ # List of entries in the folder. { # Represents a single content entry. "folder": { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. # A subfolder. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -401,7 +401,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.html b/docs/dyn/dataform_v1beta1.projects.locations.html index 51f7c1f90e..4936ab1492 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.html @@ -227,9 +227,9 @@Method Details
Returns the contents of a caller's root folder in a given location. The root folder contains all resources that are created by the user and not contained in any other folder. Args: - location: string, Required. Location of the user root folder whose contents to list. Format: projects/*/locations/* (required) - filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""` - orderBy: string, Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), created_at, last_modified_at. Examples: - `orderBy="display_name"` - `orderBy="display_name desc"` + location: string, Required. Location of the user root folder to list contents for. Format: projects/*/locations/* (required) + filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""` + orderBy: string, Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), created_at, last_modified_at. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"` pageSize: integer, Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. pageToken: string, Optional. Page token received from a previous `QueryUserRootContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryUserRootFolderContents`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. @@ -244,7 +244,7 @@Method Details
"entries": [ # List of entries in the folder. { # Represents a single content entry. "folder": { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. # A subfolder. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -262,7 +262,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html index 5760cd35f0..287c834e77 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html @@ -241,7 +241,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -284,7 +284,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -419,7 +419,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -510,7 +510,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -615,7 +615,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -658,7 +658,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html index a624bebdd1..fc40fd8956 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html @@ -607,7 +607,7 @@Method Details
path: string, Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used. view: string, Optional. Specifies the metadata to return for each directory entry. If unspecified, the default is `DIRECTORY_CONTENTS_VIEW_BASIC`. Currently the `DIRECTORY_CONTENTS_VIEW_METADATA` view is not supported by CMEK-protected workspaces. Allowed values - DIRECTORY_CONTENTS_VIEW_UNSPECIFIED - The default / unset value. Defaults to DIRECTORY_CONTENTS_VIEW_BASIC. + DIRECTORY_CONTENTS_VIEW_UNSPECIFIED - The default unset value. Defaults to DIRECTORY_CONTENTS_VIEW_BASIC. DIRECTORY_CONTENTS_VIEW_BASIC - Includes only the file or directory name. This is the default behavior. DIRECTORY_CONTENTS_VIEW_METADATA - Includes all metadata for each file or directory. Currently not supported by CMEK-protected workspaces. x__xgafv: string, V1 error format. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html b/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html index 0b7ff5ae95..899c63a353 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html @@ -317,9 +317,9 @@Method Details
Returns the contents of a given TeamFolder. Args: - teamFolder: string, Required. Name of the team_folder whose contents to list. Format: `projects/*/locations/*/teamFolders/*`. (required) - filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""` - orderBy: string, Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: `display_name` (default), `create_time`, last_modified_time. Examples: - `orderBy="display_name"` - `orderBy="display_name desc"` + teamFolder: string, Required. Resource name of the TeamFolder to list contents for. Format: `projects/*/locations/*/teamFolders/*`. (required) + filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""` + orderBy: string, Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: `display_name` (default), `create_time`, last_modified_time. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"` pageSize: integer, Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. pageToken: string, Optional. Page token received from a previous `QueryTeamFolderContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryTeamFolderContents`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. @@ -334,7 +334,7 @@Method Details
"entries": [ # List of entries in the TeamFolder. { # Represents a single content entry. "folder": { # Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls. # A subfolder. - "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder. + "containingFolder": "A String", # Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. "createTime": "A String", # Output only. The timestamp of when the Folder was created. "creatorIamPrincipal": "A String", # Output only. The IAM principal identifier of the creator of the Folder. "displayName": "A String", # Required. The Folder's user-friendly name. @@ -352,7 +352,7 @@Method Details
"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. + "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -402,8 +402,8 @@Method Details
Args: location: string, Required. Location in which to query TeamFolders. Format: `projects/*/locations/*`. (required) - filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""` - orderBy: string, Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples: - `orderBy="display_name"` - `orderBy="display_name desc"` + filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""` + orderBy: string, Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"` pageSize: integer, Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. pageToken: string, Optional. Page token received from a previous `SearchTeamFolders` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchTeamFolders`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. diff --git a/googleapiclient/discovery_cache/documents/dataform.v1.json b/googleapiclient/discovery_cache/documents/dataform.v1.json index 982662ae30..8662b27eee 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1.json @@ -125,6 +125,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://dataform.europe-west6.rep.googleapis.com/", "location": "europe-west6" }, @@ -190,6 +195,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://dataform.us-east5.rep.googleapis.com/", "location": "us-east5" }, @@ -428,19 +438,19 @@ ], "parameters": { "filter": { -"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter=\"display_name=\"MyFolder\"\"`", +"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter=\"display_name=\"MyFolder\"\"`", "location": "query", "type": "string" }, "location": { -"description": "Required. Location of the user root folder whose contents to list. Format: projects/*/locations/*", +"description": "Required. Location of the user root folder to list contents for. Format: projects/*/locations/*", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "orderBy": { -"description": "Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), created_at, last_modified_at. Examples: - `orderBy=\"display_name\"` - `orderBy=\"display_name desc\"`", +"description": "Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), created_at, last_modified_at. Examples: * `orderBy=\"display_name\"` * `orderBy=\"display_name desc\"`", "location": "query", "type": "string" }, @@ -720,19 +730,19 @@ ], "parameters": { "filter": { -"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter=\"display_name=\"MyFolder\"\"`", +"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter=\"display_name=\"MyFolder\"\"`", "location": "query", "type": "string" }, "folder": { -"description": "Required. Name of the folder whose contents to list. Format: projects/*/locations/*/folders/*", +"description": "Required. Resource name of the Folder to list contents for. Format: projects/*/locations/*/folders/*", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/folders/[^/]+$", "required": true, "type": "string" }, "orderBy": { -"description": "Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples: - `orderBy=\"display_name\"` - `orderBy=\"display_name desc\"`", +"description": "Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples: * `orderBy=\"display_name\"` * `orderBy=\"display_name desc\"`", "location": "query", "type": "string" }, @@ -2607,7 +2617,7 @@ "DIRECTORY_CONTENTS_VIEW_METADATA" ], "enumDescriptions": [ -"The default / unset value. Defaults to DIRECTORY_CONTENTS_VIEW_BASIC.", +"The default unset value. Defaults to DIRECTORY_CONTENTS_VIEW_BASIC.", "Includes only the file or directory name. This is the default behavior.", "Includes all metadata for each file or directory. Currently not supported by CMEK-protected workspaces." ], @@ -3076,12 +3086,12 @@ ], "parameters": { "filter": { -"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter=\"display_name=\"MyFolder\"\"`", +"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter=\"display_name=\"MyFolder\"\"`", "location": "query", "type": "string" }, "orderBy": { -"description": "Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: `display_name` (default), `create_time`, last_modified_time. Examples: - `orderBy=\"display_name\"` - `orderBy=\"display_name desc\"`", +"description": "Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: `display_name` (default), `create_time`, last_modified_time. Examples: * `orderBy=\"display_name\"` * `orderBy=\"display_name desc\"`", "location": "query", "type": "string" }, @@ -3097,7 +3107,7 @@ "type": "string" }, "teamFolder": { -"description": "Required. Name of the team_folder whose contents to list. Format: `projects/*/locations/*/teamFolders/*`.", +"description": "Required. Resource name of the TeamFolder to list contents for. Format: `projects/*/locations/*/teamFolders/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$", "required": true, @@ -3123,7 +3133,7 @@ ], "parameters": { "filter": { -"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter=\"display_name=\"MyFolder\"\"`", +"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter=\"display_name=\"MyFolder\"\"`", "location": "query", "type": "string" }, @@ -3135,7 +3145,7 @@ "type": "string" }, "orderBy": { -"description": "Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples: - `orderBy=\"display_name\"` - `orderBy=\"display_name desc\"`", +"description": "Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples: * `orderBy=\"display_name\"` * `orderBy=\"display_name desc\"`", "location": "query", "type": "string" }, @@ -3225,7 +3235,7 @@ } } }, -"revision": "20260326", +"revision": "20260409", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { @@ -4082,7 +4092,7 @@ "id": "Folder", "properties": { "containingFolder": { -"description": "Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder.", +"description": "Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just \"\" if this is a root Folder. This field can only be updated through MoveFolder.", "type": "string" }, "createTime": { @@ -4147,7 +4157,7 @@ "type": "string" }, "defaultBranch": { -"description": "Required. The Git remote's default branch name.", +"description": "Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.", "type": "string" }, "sshAuthenticationConfig": { diff --git a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json index 27b8ddfb98..8c13f3af95 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json @@ -125,6 +125,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://dataform.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://dataform.europe-west6.rep.googleapis.com/", "location": "europe-west6" }, @@ -190,6 +195,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://dataform.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://dataform.us-east5.rep.googleapis.com/", "location": "us-east5" }, @@ -428,19 +438,19 @@ ], "parameters": { "filter": { -"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter=\"display_name=\"MyFolder\"\"`", +"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter=\"display_name=\"MyFolder\"\"`", "location": "query", "type": "string" }, "location": { -"description": "Required. Location of the user root folder whose contents to list. Format: projects/*/locations/*", +"description": "Required. Location of the user root folder to list contents for. Format: projects/*/locations/*", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "orderBy": { -"description": "Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), created_at, last_modified_at. Examples: - `orderBy=\"display_name\"` - `orderBy=\"display_name desc\"`", +"description": "Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), created_at, last_modified_at. Examples: * `orderBy=\"display_name\"` * `orderBy=\"display_name desc\"`", "location": "query", "type": "string" }, @@ -726,19 +736,19 @@ ], "parameters": { "filter": { -"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter=\"display_name=\"MyFolder\"\"`", +"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter=\"display_name=\"MyFolder\"\"`", "location": "query", "type": "string" }, "folder": { -"description": "Required. Name of the folder whose contents to list. Format: projects/*/locations/*/folders/*", +"description": "Required. Resource name of the Folder to list contents for. Format: projects/*/locations/*/folders/*", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/folders/[^/]+$", "required": true, "type": "string" }, "orderBy": { -"description": "Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples: - `orderBy=\"display_name\"` - `orderBy=\"display_name desc\"`", +"description": "Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples: * `orderBy=\"display_name\"` * `orderBy=\"display_name desc\"`", "location": "query", "type": "string" }, @@ -2613,7 +2623,7 @@ "DIRECTORY_CONTENTS_VIEW_METADATA" ], "enumDescriptions": [ -"The default / unset value. Defaults to DIRECTORY_CONTENTS_VIEW_BASIC.", +"The default unset value. Defaults to DIRECTORY_CONTENTS_VIEW_BASIC.", "Includes only the file or directory name. This is the default behavior.", "Includes all metadata for each file or directory. Currently not supported by CMEK-protected workspaces." ], @@ -3088,12 +3098,12 @@ ], "parameters": { "filter": { -"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter=\"display_name=\"MyFolder\"\"`", +"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter=\"display_name=\"MyFolder\"\"`", "location": "query", "type": "string" }, "orderBy": { -"description": "Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: `display_name` (default), `create_time`, last_modified_time. Examples: - `orderBy=\"display_name\"` - `orderBy=\"display_name desc\"`", +"description": "Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: `display_name` (default), `create_time`, last_modified_time. Examples: * `orderBy=\"display_name\"` * `orderBy=\"display_name desc\"`", "location": "query", "type": "string" }, @@ -3109,7 +3119,7 @@ "type": "string" }, "teamFolder": { -"description": "Required. Name of the team_folder whose contents to list. Format: `projects/*/locations/*/teamFolders/*`.", +"description": "Required. Resource name of the TeamFolder to list contents for. Format: `projects/*/locations/*/teamFolders/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$", "required": true, @@ -3135,7 +3145,7 @@ ], "parameters": { "filter": { -"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter=\"display_name=\"MyFolder\"\"`", +"description": "Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter=\"display_name=\"MyFolder\"\"`", "location": "query", "type": "string" }, @@ -3147,7 +3157,7 @@ "type": "string" }, "orderBy": { -"description": "Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples: - `orderBy=\"display_name\"` - `orderBy=\"display_name desc\"`", +"description": "Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples: * `orderBy=\"display_name\"` * `orderBy=\"display_name desc\"`", "location": "query", "type": "string" }, @@ -3237,7 +3247,7 @@ } } }, -"revision": "20260326", +"revision": "20260409", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { @@ -4094,7 +4104,7 @@ "id": "Folder", "properties": { "containingFolder": { -"description": "Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder.", +"description": "Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just \"\" if this is a root Folder. This field can only be updated through MoveFolder.", "type": "string" }, "createTime": { @@ -4159,7 +4169,7 @@ "type": "string" }, "defaultBranch": { -"description": "Required. The Git remote's default branch name.", +"description": "Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.", "type": "string" }, "sshAuthenticationConfig": { From 34df3a389ca729da62f8b77127e5545ce39b7264 Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 21 Apr 2026 07:41:56 +0000 Subject: [PATCH 09/18] feat(developerknowledge): update the api #### developerknowledge:v1alpha The following keys were added: - resources.documents.methods.batchGet.parameters.view (Total Keys: 2) - resources.documents.methods.get.parameters.view (Total Keys: 2) - resources.documents.methods.searchDocumentChunks.parameters.filter (Total Keys: 2) - resources.v1alpha.methods.answerQuery (Total Keys: 8) - schemas.Answer (Total Keys: 9) - schemas.Document.properties.dataSource (Total Keys: 2) - schemas.Document.properties.updateTime (Total Keys: 3) - schemas.Document.properties.view (Total Keys: 2) - schemas.DocumentChunk.properties.document (Total Keys: 2) --- .../developerknowledge_v1alpha.documents.html | 85 ++++++--- docs/dyn/developerknowledge_v1alpha.html | 5 + .../developerknowledge_v1alpha.v1alpha.html | 116 ++++++++++++ .../documents/developerknowledge.v1alpha.json | 166 ++++++++++++++++-- 4 files changed, 328 insertions(+), 44 deletions(-) create mode 100644 docs/dyn/developerknowledge_v1alpha.v1alpha.html diff --git a/docs/dyn/developerknowledge_v1alpha.documents.html b/docs/dyn/developerknowledge_v1alpha.documents.html index 821d2b7d1e..e31b260243 100644 --- a/docs/dyn/developerknowledge_v1alpha.documents.html +++ b/docs/dyn/developerknowledge_v1alpha.documents.html @@ -75,27 +75,33 @@ Developer Knowledge API . documents
Instance Methods
-
+batchGet(names=None, x__xgafv=None)batchGet(names=None, view=None, x__xgafv=None)Retrieves multiple documents, each with its full Markdown content.
Close httplib2 connections.
+get(name, view=None, x__xgafv=None)Retrieves a single document with its full Markdown content.
-
-searchDocumentChunks(pageSize=None, pageToken=None, query=None, x__xgafv=None)Searches for developer knowledge across Google's developer documentation. This method returns document chunks based on the user's query. There can be many chunks of the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results.
+searchDocumentChunks(filter=None, pageSize=None, pageToken=None, query=None, x__xgafv=None)+Searches for developer knowledge across Google's developer documentation. Returns DocumentChunks based on the user's query. There may be many chunks from the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results.
Retrieves the next page of results.
Method Details
-batchGet(names=None, x__xgafv=None)+batchGet(names=None, view=None, x__xgafv=None)Retrieves multiple documents, each with its full Markdown content. Args: - names: string, Required. The names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` (repeated) + names: string, Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` (repeated) + view: string, Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.BatchGetDocuments defaults to `DOCUMENT_VIEW_CONTENT`. + Allowed values + DOCUMENT_VIEW_UNSPECIFIED - The default / unset value. See each API method for its default value if DocumentView is not specified. + DOCUMENT_VIEW_BASIC - Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks. + DOCUMENT_VIEW_FULL - Includes all Document fields. + DOCUMENT_VIEW_CONTENT - Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -105,12 +111,16 @@@@ -122,11 +132,17 @@Method Details
An object of the form: { # Response message for DeveloperKnowledge.BatchGetDocuments. - "documents": [ # Documents requested. + "documents": [ # Contains the documents requested. { # A Document represents a piece of content from the Developer Knowledge corpus. - "content": "A String", # Output only. The full content of the document in Markdown format. - "description": "A String", # Output only. A description of the document. - "name": "A String", # Identifier. The resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` - "uri": "A String", # Output only. The URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`. + "content": "A String", # Output only. Contains the full content of the document in Markdown format. + "dataSource": "A String", # Output only. Specifies the data source of the document. Example data source: `firebase.google.com` + "description": "A String", # Output only. Provides a description of the document. + "name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + "title": "A String", # Output only. Provides the title of the document. + "updateTime": "A String", # Output only. Represents the timestamp when the content or metadata of the document was last updated. + "uri": "A String", # Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`. + "view": "A String", # Output only. Specifies the DocumentView of the document. }, ], }Method Details
-get(name, x__xgafv=None)+get(name, view=None, x__xgafv=None)Retrieves a single document with its full Markdown content. Args: - name: string, Required. The name of the document to retrieve. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` (required) + name: string, Required. Specifies the name of the document to retrieve. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` (required) + view: string, Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.GetDocument defaults to `DOCUMENT_VIEW_CONTENT`. + Allowed values + DOCUMENT_VIEW_UNSPECIFIED - The default / unset value. See each API method for its default value if DocumentView is not specified. + DOCUMENT_VIEW_BASIC - Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks. + DOCUMENT_VIEW_FULL - Includes all Document fields. + DOCUMENT_VIEW_CONTENT - Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -136,21 +152,26 @@Method Details
An object of the form: { # A Document represents a piece of content from the Developer Knowledge corpus. - "content": "A String", # Output only. The full content of the document in Markdown format. - "description": "A String", # Output only. A description of the document. - "name": "A String", # Identifier. The resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` - "uri": "A String", # Output only. The URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`. + "content": "A String", # Output only. Contains the full content of the document in Markdown format. + "dataSource": "A String", # Output only. Specifies the data source of the document. Example data source: `firebase.google.com` + "description": "A String", # Output only. Provides a description of the document. + "name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + "title": "A String", # Output only. Provides the title of the document. + "updateTime": "A String", # Output only. Represents the timestamp when the content or metadata of the document was last updated. + "uri": "A String", # Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`. + "view": "A String", # Output only. Specifies the DocumentView of the document. }-+ +searchDocumentChunks(pageSize=None, pageToken=None, query=None, x__xgafv=None)-Searches for developer knowledge across Google's developer documentation. This method returns document chunks based on the user's query. There can be many chunks of the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results. ++searchDocumentChunks(filter=None, pageSize=None, pageToken=None, query=None, x__xgafv=None)+Searches for developer knowledge across Google's developer documentation. Returns DocumentChunks based on the user's query. There may be many chunks from the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results. Args: - pageSize: integer, Optional. The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 20; values above 20 will result in an INVALID_ARGUMENT error. - pageToken: string, Optional. A page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page. - query: string, Required. The raw query string provided by the user, such as "How to create a Cloud Storage bucket?". + filter: string, Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * `data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"` * `data_source != "firebase.google.com"` * `update_time < "2024-01-01T00:00:00Z"` * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")` * `uri = "https://docs.cloud.google.com/release-notes"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error. + pageSize: integer, Optional. Specifies the maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 20; values above 20 will result in an INVALID_ARGUMENT error. + pageToken: string, Optional. Contains a page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page. + query: string, Required. Provides the raw query string provided by the user, such as "How to create a Cloud Storage bucket?". x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -160,12 +181,22 @@diff --git a/docs/dyn/developerknowledge_v1alpha.html b/docs/dyn/developerknowledge_v1alpha.html index 399cdf72f7..e19c8c79ef 100644 --- a/docs/dyn/developerknowledge_v1alpha.html +++ b/docs/dyn/developerknowledge_v1alpha.html @@ -79,6 +79,11 @@Method Details
An object of the form: { # Response message for DeveloperKnowledge.SearchDocumentChunks. - "nextPageToken": "A String", # Optional. A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - "results": [ # The search results for the given query. Each DocumentChunk in this list contains a snippet of content relevant to the search query. Use the DocumentChunk.parent field of each result with DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to retrieve the full document content. + "nextPageToken": "A String", # Optional. Provides a token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "results": [ # Contains the search results for the given query. Each DocumentChunk in this list contains a snippet of content relevant to the search query. Use the DocumentChunk.parent field of each result with DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to retrieve the full document content. { # A DocumentChunk represents a piece of content from a Document in the DeveloperKnowledge corpus. To fetch the entire document content, pass the `parent` to DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments. - "content": "A String", # Output only. The content of the document chunk. - "id": "A String", # Output only. The ID of this chunk within the document. The chunk ID is unique within a document, but not globally unique across documents. The chunk ID is not stable and may change over time. - "parent": "A String", # Output only. The resource name of the document this chunk is from. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + "content": "A String", # Output only. Contains the content of the document chunk. + "document": { # A Document represents a piece of content from the Developer Knowledge corpus. # Output only. Represents metadata about the Document this chunk is from. The DocumentView of this Document message will be set to `DOCUMENT_VIEW_BASIC`. It is included here for convenience so that clients do not need to call DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments if they only need the metadata fields. Otherwise, clients should use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to fetch the full document content. + "content": "A String", # Output only. Contains the full content of the document in Markdown format. + "dataSource": "A String", # Output only. Specifies the data source of the document. Example data source: `firebase.google.com` + "description": "A String", # Output only. Provides a description of the document. + "name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + "title": "A String", # Output only. Provides the title of the document. + "updateTime": "A String", # Output only. Represents the timestamp when the content or metadata of the document was last updated. + "uri": "A String", # Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`. + "view": "A String", # Output only. Specifies the DocumentView of the document. + }, + "id": "A String", # Output only. Specifies the ID of this chunk within the document. The chunk ID is unique within a document, but not globally unique across documents. The chunk ID is not stable and may change over time. + "parent": "A String", # Output only. Contains the resource name of the document this chunk is from. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` }, ], }Instance Methods
Returns the documents Resource.
++
+v1alpha()+Returns the v1alpha Resource.
+Close httplib2 connections.
diff --git a/docs/dyn/developerknowledge_v1alpha.v1alpha.html b/docs/dyn/developerknowledge_v1alpha.v1alpha.html new file mode 100644 index 0000000000..795036992c --- /dev/null +++ b/docs/dyn/developerknowledge_v1alpha.v1alpha.html @@ -0,0 +1,116 @@ + + + +Developer Knowledge API . v1alpha
+Instance Methods
++
+answerQuery(body=None, x__xgafv=None)Answers a query using grounded generation.
++
+close()Close httplib2 connections.
+Method Details
+++ +answerQuery(body=None, x__xgafv=None)+Answers a query using grounded generation. + +Args: + body: object, The request body. + The object takes the form of: + +{ # Request message for DeveloperKnowledge.AnswerQuery. + "query": "A String", # Required. The query to answer. +} + + 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 DeveloperKnowledge.AnswerQuery. + "answer": { # An answer to a query. # The answer to the query. + "answerText": "A String", # The text of the answer. + }, +}+++ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json b/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json index 15162028f5..358e203dd7 100644 --- a/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json @@ -115,10 +115,27 @@ "parameterOrder": [], "parameters": { "names": { -"description": "Required. The names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`", +"description": "Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`", "location": "query", "repeated": true, "type": "string" +}, +"view": { +"description": "Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.BatchGetDocuments defaults to `DOCUMENT_VIEW_CONTENT`.", +"enum": [ +"DOCUMENT_VIEW_UNSPECIFIED", +"DOCUMENT_VIEW_BASIC", +"DOCUMENT_VIEW_FULL", +"DOCUMENT_VIEW_CONTENT" +], +"enumDescriptions": [ +"The default / unset value. See each API method for its default value if DocumentView is not specified.", +"Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.", +"Includes all Document fields.", +"Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments." +], +"location": "query", +"type": "string" } }, "path": "v1alpha/documents:batchGet", @@ -139,11 +156,28 @@ ], "parameters": { "name": { -"description": "Required. The name of the document to retrieve. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`", +"description": "Required. Specifies the name of the document to retrieve. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`", "location": "path", "pattern": "^documents/.*$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.GetDocument defaults to `DOCUMENT_VIEW_CONTENT`.", +"enum": [ +"DOCUMENT_VIEW_UNSPECIFIED", +"DOCUMENT_VIEW_BASIC", +"DOCUMENT_VIEW_FULL", +"DOCUMENT_VIEW_CONTENT" +], +"enumDescriptions": [ +"The default / unset value. See each API method for its default value if DocumentView is not specified.", +"Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.", +"Includes all Document fields.", +"Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments." +], +"location": "query", +"type": "string" } }, "path": "v1alpha/{+name}", @@ -155,25 +189,30 @@ ] }, "searchDocumentChunks": { -"description": "Searches for developer knowledge across Google's developer documentation. This method returns document chunks based on the user's query. There can be many chunks of the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results.", +"description": "Searches for developer knowledge across Google's developer documentation. Returns DocumentChunks based on the user's query. There may be many chunks from the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results.", "flatPath": "v1alpha/documents:searchDocumentChunks", "httpMethod": "GET", "id": "developerknowledge.documents.searchDocumentChunks", "parameterOrder": [], "parameters": { +"filter": { +"description": "Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `\"2025-01-01T00:00:00Z\"`. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * `data_source = \"docs.cloud.google.com\" OR data_source = \"firebase.google.com\"` * `data_source != \"firebase.google.com\"` * `update_time < \"2024-01-01T00:00:00Z\"` * `update_time >= \"2025-01-22T00:00:00Z\" AND (data_source = \"developer.chrome.com\" OR data_source = \"web.dev\")` * `uri = \"https://docs.cloud.google.com/release-notes\"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.", +"location": "query", +"type": "string" +}, "pageSize": { -"description": "Optional. The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 20; values above 20 will result in an INVALID_ARGUMENT error.", +"description": "Optional. Specifies the maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 20; values above 20 will result in an INVALID_ARGUMENT error.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page.", +"description": "Optional. Contains a page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "query": { -"description": "Required. The raw query string provided by the user, such as \"How to create a Cloud Storage bucket?\".", +"description": "Required. Provides the raw query string provided by the user, such as \"How to create a Cloud Storage bucket?\".", "location": "query", "type": "string" } @@ -187,17 +226,72 @@ ] } } +}, +"v1alpha": { +"methods": { +"answerQuery": { +"description": "Answers a query using grounded generation.", +"flatPath": "v1alpha:answerQuery", +"httpMethod": "POST", +"id": "developerknowledge.answerQuery", +"parameterOrder": [], +"parameters": {}, +"path": "v1alpha:answerQuery", +"request": { +"$ref": "AnswerQueryRequest" +}, +"response": { +"$ref": "AnswerQueryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} } }, -"revision": "20260223", +"revision": "20260413", "rootUrl": "https://developerknowledge.googleapis.com/", "schemas": { +"Answer": { +"description": "An answer to a query.", +"id": "Answer", +"properties": { +"answerText": { +"description": "The text of the answer.", +"type": "string" +} +}, +"type": "object" +}, +"AnswerQueryRequest": { +"description": "Request message for DeveloperKnowledge.AnswerQuery.", +"id": "AnswerQueryRequest", +"properties": { +"query": { +"description": "Required. The query to answer.", +"type": "string" +} +}, +"type": "object" +}, +"AnswerQueryResponse": { +"description": "Response message for DeveloperKnowledge.AnswerQuery.", +"id": "AnswerQueryResponse", +"properties": { +"answer": { +"$ref": "Answer", +"description": "The answer to the query." +} +}, +"type": "object" +}, "BatchGetDocumentsResponse": { "description": "Response message for DeveloperKnowledge.BatchGetDocuments.", "id": "BatchGetDocumentsResponse", "properties": { "documents": { -"description": "Documents requested.", +"description": "Contains the documents requested.", "items": { "$ref": "Document" }, @@ -211,21 +305,54 @@ "id": "Document", "properties": { "content": { -"description": "Output only. The full content of the document in Markdown format.", +"description": "Output only. Contains the full content of the document in Markdown format.", +"readOnly": true, +"type": "string" +}, +"dataSource": { +"description": "Output only. Specifies the data source of the document. Example data source: `firebase.google.com`", "readOnly": true, "type": "string" }, "description": { -"description": "Output only. A description of the document.", +"description": "Output only. Provides a description of the document.", "readOnly": true, "type": "string" }, "name": { -"description": "Identifier. The resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`", +"description": "Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`", +"type": "string" +}, +"title": { +"description": "Output only. Provides the title of the document.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Represents the timestamp when the content or metadata of the document was last updated.", +"format": "google-datetime", +"readOnly": true, "type": "string" }, "uri": { -"description": "Output only. The URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`.", +"description": "Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`.", +"readOnly": true, +"type": "string" +}, +"view": { +"description": "Output only. Specifies the DocumentView of the document.", +"enum": [ +"DOCUMENT_VIEW_UNSPECIFIED", +"DOCUMENT_VIEW_BASIC", +"DOCUMENT_VIEW_FULL", +"DOCUMENT_VIEW_CONTENT" +], +"enumDescriptions": [ +"The default / unset value. See each API method for its default value if DocumentView is not specified.", +"Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.", +"Includes all Document fields.", +"Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments." +], "readOnly": true, "type": "string" } @@ -237,17 +364,22 @@ "id": "DocumentChunk", "properties": { "content": { -"description": "Output only. The content of the document chunk.", +"description": "Output only. Contains the content of the document chunk.", "readOnly": true, "type": "string" }, +"document": { +"$ref": "Document", +"description": "Output only. Represents metadata about the Document this chunk is from. The DocumentView of this Document message will be set to `DOCUMENT_VIEW_BASIC`. It is included here for convenience so that clients do not need to call DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments if they only need the metadata fields. Otherwise, clients should use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to fetch the full document content.", +"readOnly": true +}, "id": { -"description": "Output only. The ID of this chunk within the document. The chunk ID is unique within a document, but not globally unique across documents. The chunk ID is not stable and may change over time.", +"description": "Output only. Specifies the ID of this chunk within the document. The chunk ID is unique within a document, but not globally unique across documents. The chunk ID is not stable and may change over time.", "readOnly": true, "type": "string" }, "parent": { -"description": "Output only. The resource name of the document this chunk is from. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`", +"description": "Output only. Contains the resource name of the document this chunk is from. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`", "readOnly": true, "type": "string" } @@ -259,11 +391,11 @@ "id": "SearchDocumentChunksResponse", "properties": { "nextPageToken": { -"description": "Optional. A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"description": "Optional. Provides a token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "results": { -"description": "The search results for the given query. Each DocumentChunk in this list contains a snippet of content relevant to the search query. Use the DocumentChunk.parent field of each result with DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to retrieve the full document content.", +"description": "Contains the search results for the given query. Each DocumentChunk in this list contains a snippet of content relevant to the search query. Use the DocumentChunk.parent field of each result with DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to retrieve the full document content.", "items": { "$ref": "DocumentChunk" }, From 3361e155032db09fcb31d4de9c69cb2f0fcf06fb Mon Sep 17 00:00:00 2001 From: Yoshi Automationclose()+Close httplib2 connections.+Date: Tue, 21 Apr 2026 07:41:56 +0000 Subject: [PATCH 10/18] feat(docs): update the api #### docs:v1 The following keys were added: - schemas.Request.properties.updateNamedStyle.$ref (Total Keys: 1) - schemas.UpdateNamedStyleRequest (Total Keys: 6) --- docs/dyn/docs_v1.documents.html | 207 ++++++++++++++++++ .../discovery_cache/documents/docs.v1.json | 26 ++- 2 files changed, 232 insertions(+), 1 deletion(-) diff --git a/docs/dyn/docs_v1.documents.html b/docs/dyn/docs_v1.documents.html index fa97032123..a3dfd2c905 100644 --- a/docs/dyn/docs_v1.documents.html +++ b/docs/dyn/docs_v1.documents.html @@ -503,6 +503,213 @@ Method Details
"title": "A String", # The user-visible name of the tab. }, }, + "updateNamedStyle": { # Updates a named style. # Updates a named style. + "fields": "A String", # The NamedStyle fields that should be updated. At least `named_style_type must be specified. The root `named_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to include `"text_style"` and `"text_style.bold"`. To update the paragraph style's alignment property, set `fields` to include `"paragraph_style"` and `"paragraph_style.alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. Specifying `"text_style"` or `"paragraph_style"` with an empty TextStyle or ParagraphStyle will reset all of its nested fields. + "namedStyle": { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. # The document style to update. + "namedStyleType": "A String", # The type of this named style. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "tabId": "A String", # The document tab to update. By default, the update is applied to the first tab. + }, "updateParagraphStyle": { # Update the styling of all paragraphs that overlap with the given range. # Updates the paragraph style at the specified range. "fields": "A String", # The fields that should be updated. At least one field must be specified. The root `paragraph_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the paragraph style's alignment property, set `fields` to `"alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The styles to set on the paragraphs. Certain paragraph style changes may cause other changes in order to mirror the behavior of the Docs editor. See the documentation of ParagraphStyle for more information. diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index 8bdef730ae..3628b2b12a 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -221,7 +221,7 @@ } } }, -"revision": "20260408", +"revision": "20260415", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AddDocumentTabRequest": { @@ -3401,6 +3401,10 @@ "$ref": "UpdateDocumentTabPropertiesRequest", "description": "Updates the properties of a document tab." }, +"updateNamedStyle": { +"$ref": "UpdateNamedStyleRequest", +"description": "Updates a named style." +}, "updateParagraphStyle": { "$ref": "UpdateParagraphStyleRequest", "description": "Updates the paragraph style at the specified range." @@ -4736,6 +4740,26 @@ }, "type": "object" }, +"UpdateNamedStyleRequest": { +"description": "Updates a named style.", +"id": "UpdateNamedStyleRequest", +"properties": { +"fields": { +"description": "The NamedStyle fields that should be updated. At least `named_style_type must be specified. The root `named_style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to include `\"text_style\"` and `\"text_style.bold\"`. To update the paragraph style's alignment property, set `fields` to include `\"paragraph_style\"` and `\"paragraph_style.alignment\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. Specifying `\"text_style\"` or `\"paragraph_style\"` with an empty TextStyle or ParagraphStyle will reset all of its nested fields.", +"format": "google-fieldmask", +"type": "string" +}, +"namedStyle": { +"$ref": "NamedStyle", +"description": "The document style to update." +}, +"tabId": { +"description": "The document tab to update. By default, the update is applied to the first tab.", +"type": "string" +} +}, +"type": "object" +}, "UpdateParagraphStyleRequest": { "description": "Update the styling of all paragraphs that overlap with the given range.", "id": "UpdateParagraphStyleRequest", From 052d815d37c4bc42242949b536341e5b38862822 Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 21 Apr 2026 07:41:56 +0000 Subject: [PATCH 11/18] feat(health): update the api #### health:v4 The following keys were added: - resources.projects.resources.subscribers.methods.create (Total Keys: 14) - resources.projects.resources.subscribers.methods.delete (Total Keys: 13) - resources.projects.resources.subscribers.methods.list (Total Keys: 16) - resources.projects.resources.subscribers.methods.patch (Total Keys: 15) - resources.users.resources.dataTypes.resources.dataPoints.methods.get (Total Keys: 10) - schemas.CreateSubscriberPayload (Total Keys: 6) - schemas.DailyRollupDataPoint.properties.swimLengthsData.$ref (Total Keys: 1) - schemas.DataPoint.properties.height.$ref (Total Keys: 1) - schemas.DataPoint.properties.swimLengthsData.$ref (Total Keys: 1) - schemas.EndpointAuthorization (Total Keys: 5) - schemas.Height (Total Keys: 5) - schemas.HttpHeader (Total Keys: 4) - schemas.HttpResponse (Total Keys: 9) - schemas.ListSubscribersResponse (Total Keys: 7) - schemas.ReconciledDataPoint.properties.height.$ref (Total Keys: 1) - schemas.ReconciledDataPoint.properties.swimLengthsData.$ref (Total Keys: 1) - schemas.RollupDataPoint.properties.swimLengthsData.$ref (Total Keys: 1) - schemas.Subscriber (Total Keys: 20) - schemas.SwimLengthsData (Total Keys: 10) - schemas.WebhookNotificationCloudLog (Total Keys: 3) --- docs/dyn/health_v4.html | 5 + docs/dyn/health_v4.projects.html | 91 ++ docs/dyn/health_v4.projects.subscribers.html | 308 ++++ .../health_v4.users.dataTypes.dataPoints.html | 1345 +++++++++++++++-- .../discovery_cache/documents/health.v4.json | 458 +++++- 5 files changed, 2116 insertions(+), 91 deletions(-) create mode 100644 docs/dyn/health_v4.projects.html create mode 100644 docs/dyn/health_v4.projects.subscribers.html diff --git a/docs/dyn/health_v4.html b/docs/dyn/health_v4.html index e75232bd57..4cd1e75e7f 100644 --- a/docs/dyn/health_v4.html +++ b/docs/dyn/health_v4.html @@ -74,6 +74,11 @@ Google Health API
Instance Methods
++
+projects()+Returns the projects Resource.
+ diff --git a/docs/dyn/health_v4.projects.html b/docs/dyn/health_v4.projects.html new file mode 100644 index 0000000000..5bf004bc88 --- /dev/null +++ b/docs/dyn/health_v4.projects.html @@ -0,0 +1,91 @@ + + + +Google Health API . projects
+Instance Methods
++
+subscribers()+Returns the subscribers Resource.
+ ++
+close()Close httplib2 connections.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/health_v4.projects.subscribers.html b/docs/dyn/health_v4.projects.subscribers.html new file mode 100644 index 0000000000..11b7bf2b39 --- /dev/null +++ b/docs/dyn/health_v4.projects.subscribers.html @@ -0,0 +1,308 @@ + + + +close()+Close httplib2 connections.+Google Health API . projects . subscribers
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, body=None, subscriberId=None, x__xgafv=None)Registers a new subscriber endpoint to receive notifications. A subscriber represents an application or service that wishes to receive data change notifications for users who have granted consent. **Endpoint Verification:** For a subscriber to be successfully created, the provided `endpoint_uri` must be a valid HTTPS endpoint and must pass an automated verification check. The backend will send two HTTP POST requests to the `endpoint_uri`: 1. **Verification with Authorization:** * **Headers:** Includes `Content-Type: application/json` and `Authorization` (with the exact value from `CreateSubscriberPayload.endpoint_authorization.secret`). * **Body:** `{"type": "verification"}` * **Expected Response:** HTTP `201 Created`. 2. **Verification without Authorization:** * **Headers:** Includes `Content-Type: application/json`. The `Authorization` header is OMITTED. * **Body:** `{"type": "verification"}` * **Expected Response:** HTTP `401 Unauthorized` or `403 Forbidden`. Both tests must pass for the subscriber creation to succeed. If verification fails, the operation will not be completed and an error will be returned. This process ensures the endpoint is reachable and correctly validates the `Authorization` header.
++
+delete(name, force=None, x__xgafv=None)Deletes a subscriber registration. This will stop all notifications to the subscriber's endpoint.
++
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)Lists all subscribers registered within the owned Google Cloud Project.
+ +Retrieves the next page of results.
++
+patch(name, body=None, updateMask=None, x__xgafv=None)Updates the configuration of an existing subscriber, such as the endpoint URI or the data types it's interested in. **Endpoint Verification:** If the `endpoint_uri` or `endpoint_authorization` field is included in the `update_mask`, the backend will re-verify the endpoint. The verification process is the same as described in `CreateSubscriber`: 1. **Verification with Authorization:** POST to the new or existing `endpoint_uri` with the new or existing `Authorization` secret. Expects HTTP `201 Created`. 2. **Verification without Authorization:** POST to the `endpoint_uri` without the `Authorization` header. Expects HTTP `401 Unauthorized` or `403 Forbidden`. Both tests must pass using the potentially updated values for the subscriber update to succeed. If verification fails, the update will not be applied, and an error will be returned.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, subscriberId=None, x__xgafv=None)+Registers a new subscriber endpoint to receive notifications. A subscriber represents an application or service that wishes to receive data change notifications for users who have granted consent. **Endpoint Verification:** For a subscriber to be successfully created, the provided `endpoint_uri` must be a valid HTTPS endpoint and must pass an automated verification check. The backend will send two HTTP POST requests to the `endpoint_uri`: 1. **Verification with Authorization:** * **Headers:** Includes `Content-Type: application/json` and `Authorization` (with the exact value from `CreateSubscriberPayload.endpoint_authorization.secret`). * **Body:** `{"type": "verification"}` * **Expected Response:** HTTP `201 Created`. 2. **Verification without Authorization:** * **Headers:** Includes `Content-Type: application/json`. The `Authorization` header is OMITTED. * **Body:** `{"type": "verification"}` * **Expected Response:** HTTP `401 Unauthorized` or `403 Forbidden`. Both tests must pass for the subscriber creation to succeed. If verification fails, the operation will not be completed and an error will be returned. This process ensures the endpoint is reachable and correctly validates the `Authorization` header. + +Args: + parent: string, Required. The parent resource where this subscriber will be created. Format: projects/{project} Example: projects/my-project-123 (required) + body: object, The request body. + The object takes the form of: + +{ # Payload for creating a subscriber. + "endpointAuthorization": { # Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `X-HEALTHAPI-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API. # Required. Authorization mechanism for the subscriber endpoint. The `secret` within this message is crucial for endpoint verification and for securing webhook notifications. + "secret": "A String", # Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the "Authorization" header. The value must include the authorization scheme, e.g., "Bearer " or "Basic ", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during `CreateSubscriber` and `UpdateSubscriber` calls, and will be sent in the `Authorization` header for all subsequent webhook notifications to this endpoint. + "secretSet": True or False, # Output only. Whether the secret is set. + }, + "endpointUri": "A String", # Required. The full HTTPS URI where update notifications will be sent. The URI must be a valid URL and use HTTPS as the scheme. This endpoint will be verified during the `CreateSubscriber` call. See CreateSubscriber RPC documentation for verification details. + "subscriberConfigs": [ # Optional. Configuration for the subscriber. + { # Configuration for a subscriber. A notification is sent to a subscription ONLY if the subscriber has a config for the data type. + "dataTypes": [ # Required. Supported data types are: "altitude", "distance", "floors", "sleep", "steps", "weight". Values should be in kebab-case. + "A String", + ], + "subscriptionCreatePolicy": "A String", # Required. Policy for subscription creation. + }, + ], +} + + subscriberId: string, Optional. The ID to use for the subscriber, which will become the final component of the subscriber's resource name. This value should be 4-36 characters, and valid characters are /[a-z]([a-z0-9-]{2,34}[a-z0-9])/. + 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. + }, +}+++ +delete(name, force=None, x__xgafv=None)+Deletes a subscriber registration. This will stop all notifications to the subscriber's endpoint. + +Args: + name: string, Required. The name of the subscriber to delete. Format: projects/{project}/subscribers/{subscriber} Example: projects/my-project/subscribers/my-subscriber-123 The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated if not provided during creation. (required) + force: boolean, Optional. If set to true, any child resources (e.g., subscriptions) will also be deleted. If false (default) and child resources exist, the request will fail. + 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. + }, +}+++ +list(parent, pageSize=None, pageToken=None, x__xgafv=None)+Lists all subscribers registered within the owned Google Cloud Project. + +Args: + parent: string, Required. The parent, which owns this collection of subscribers. Format: projects/{project} (required) + pageSize: integer, Optional. The maximum number of subscribers to return. The service may return fewer than this value. If unspecified, at most 50 subscribers 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 `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` 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 ListSubscribers. + "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. + "subscribers": [ # Subscribers from the specified project. + { # -- Resource Messages -- A subscriber receives notifications from Google Health API. + "createTime": "A String", # Output only. The time at which the subscriber was created. + "endpointAuthorization": { # Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `X-HEALTHAPI-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API. # Required. Authorization mechanism for a subscriber endpoint. This is required to ensure the endpoint can be verified. + "secret": "A String", # Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the "Authorization" header. The value must include the authorization scheme, e.g., "Bearer " or "Basic ", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during `CreateSubscriber` and `UpdateSubscriber` calls, and will be sent in the `Authorization` header for all subsequent webhook notifications to this endpoint. + "secretSet": True or False, # Output only. Whether the secret is set. + }, + "endpointUri": "A String", # Required. The full HTTPS URI where update notifications will be sent. The URI must be a valid URL and use HTTPS as the scheme. This endpoint will be verified during CreateSubscriber and UpdateSubscriber calls. See RPC documentation for verification details. + "name": "A String", # Identifier. The resource name of the Subscriber. Format: projects/{project}/subscribers/{subscriber} The {project} ID is a Google Cloud Project ID or Project Number. The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise (e.g., a UUID). Example (User-settable subscriber ID): projects/my-project/subscribers/my-sub-123 Example (System-generated subscriber ID): projects/my-project/subscribers/a1b2c3d4-e5f6-7890-1234-567890abcdef + "state": "A String", # Output only. The state of the subscriber. + "subscriberConfigs": [ # Optional. Configuration for the subscriber. + { # Configuration for a subscriber. A notification is sent to a subscription ONLY if the subscriber has a config for the data type. + "dataTypes": [ # Required. Supported data types are: "altitude", "distance", "floors", "sleep", "steps", "weight". Values should be in kebab-case. + "A String", + ], + "subscriptionCreatePolicy": "A String", # Required. Policy for subscription creation. + }, + ], + "updateTime": "A String", # Output only. The time at which the subscriber was last updated. + }, + ], + "totalSize": 42, # The total number of subscribers matching the request. +}+++ +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/health_v4.users.dataTypes.dataPoints.html b/docs/dyn/health_v4.users.dataTypes.dataPoints.html index 903840fb38..5a1f46cd92 100644 --- a/docs/dyn/health_v4.users.dataTypes.dataPoints.html +++ b/docs/dyn/health_v4.users.dataTypes.dataPoints.html @@ -92,6 +92,9 @@patch(name, body=None, updateMask=None, x__xgafv=None)+Updates the configuration of an existing subscriber, such as the endpoint URI or the data types it's interested in. **Endpoint Verification:** If the `endpoint_uri` or `endpoint_authorization` field is included in the `update_mask`, the backend will re-verify the endpoint. The verification process is the same as described in `CreateSubscriber`: 1. **Verification with Authorization:** POST to the new or existing `endpoint_uri` with the new or existing `Authorization` secret. Expects HTTP `201 Created`. 2. **Verification without Authorization:** POST to the `endpoint_uri` without the `Authorization` header. Expects HTTP `401 Unauthorized` or `403 Forbidden`. Both tests must pass using the potentially updated values for the subscriber update to succeed. If verification fails, the update will not be applied, and an error will be returned. + +Args: + name: string, Identifier. The resource name of the Subscriber. Format: projects/{project}/subscribers/{subscriber} The {project} ID is a Google Cloud Project ID or Project Number. The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise (e.g., a UUID). Example (User-settable subscriber ID): projects/my-project/subscribers/my-sub-123 Example (System-generated subscriber ID): projects/my-project/subscribers/a1b2c3d4-e5f6-7890-1234-567890abcdef (required) + body: object, The request body. + The object takes the form of: + +{ # -- Resource Messages -- A subscriber receives notifications from Google Health API. + "createTime": "A String", # Output only. The time at which the subscriber was created. + "endpointAuthorization": { # Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `X-HEALTHAPI-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API. # Required. Authorization mechanism for a subscriber endpoint. This is required to ensure the endpoint can be verified. + "secret": "A String", # Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the "Authorization" header. The value must include the authorization scheme, e.g., "Bearer " or "Basic ", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during `CreateSubscriber` and `UpdateSubscriber` calls, and will be sent in the `Authorization` header for all subsequent webhook notifications to this endpoint. + "secretSet": True or False, # Output only. Whether the secret is set. + }, + "endpointUri": "A String", # Required. The full HTTPS URI where update notifications will be sent. The URI must be a valid URL and use HTTPS as the scheme. This endpoint will be verified during CreateSubscriber and UpdateSubscriber calls. See RPC documentation for verification details. + "name": "A String", # Identifier. The resource name of the Subscriber. Format: projects/{project}/subscribers/{subscriber} The {project} ID is a Google Cloud Project ID or Project Number. The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise (e.g., a UUID). Example (User-settable subscriber ID): projects/my-project/subscribers/my-sub-123 Example (System-generated subscriber ID): projects/my-project/subscribers/a1b2c3d4-e5f6-7890-1234-567890abcdef + "state": "A String", # Output only. The state of the subscriber. + "subscriberConfigs": [ # Optional. Configuration for the subscriber. + { # Configuration for a subscriber. A notification is sent to a subscription ONLY if the subscriber has a config for the data type. + "dataTypes": [ # Required. Supported data types are: "altitude", "distance", "floors", "sleep", "steps", "weight". Values should be in kebab-case. + "A String", + ], + "subscriptionCreatePolicy": "A String", # Required. Policy for subscription creation. + }, + ], + "updateTime": "A String", # Output only. The time at which the subscriber was last updated. +} + + updateMask: string, Optional. A field mask that specifies which fields of the Subscriber message are to be updated. This allows for partial updates. Supported fields: - endpoint_uri - subscriber_configs - endpoint_authorization + 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. + }, +}+Instance Methods
exportExerciseTcx_media(name, partialData=None, x__xgafv=None)Exports exercise data in TCX format. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.
+ +Get a single identifyable data point.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Query user health and fitness data points.
@@ -690,6 +693,26 @@Method Details
}, "standardDeviationMilliseconds": 3.14, # Optional. The standard deviation of the heart rate variability measurement. }, + "height": { # Body height measurement. # Optional. Data for points in the `height` sample data type collection. + "heightMillimeters": "A String", # Required. Height of the user in millimeters. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the height was recorded. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + }, "hydrationLog": { # Holds information about a user logged hydration. # Optional. Data for points in the `hydration-log` session data type collection. "amountConsumed": { # Represents the volume quantity. # Required. Amount of liquid (ex. water) consumed. "milliliters": 3.14, # Required. Value representing the volume in milliliters. @@ -954,6 +977,42 @@Method Details
"startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). }, }, + "swimLengthsData": { # Swim lengths data over the time interval. # Optional. Data for points in the `swim-lengths-data` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + "strokeCount": "A String", # Required. Number of strokes in the lap. + "swimStrokeType": "A String", # Required. Swim stroke type. + }, "timeInHeartRateZone": { # Time in heart rate zone record. It's an interval spent in specific heart rate zone. # Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection. "heartRateZoneType": "A String", # Required. Heart rate zone type. "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. @@ -1165,7 +1224,1027 @@Method Details
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, - "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Start time of the window this value aggregates over + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Start time of the window this value aggregates over + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "distance": { # Result of the rollup of the user's distance. # Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier. + "millimetersSum": "A String", # Sum of the distance in millimeters. + }, + "floors": { # Represents the result of the rollup of the user's floors. # Returned by default when rolling up data points from the `floors` data type, or when requested explicitly using the `floors` rollup type identifier. + "countSum": "A String", # Sum of the floors count. + }, + "heartRate": { # Represents the result of the rollup of the heart rate data type. # Returned by default when rolling up data points from the `heart-rate` data type, or when requested explicitly using the `heart-rate` rollup type identifier. + "beatsPerMinuteAvg": 3.14, # The average heart rate value in the interval. + "beatsPerMinuteMax": 3.14, # The maximum heart rate value in the interval. + "beatsPerMinuteMin": 3.14, # The minimum heart rate value in the interval. + }, + "heartRateVariabilityPersonalRange": { # Represents the result of the rollup of the user's daily heart rate variability personal range. # Returned by default when rolling up data points from the `daily-heart-rate-variability` data type, or when requested explicitly using the `heart-rate-variability-personal-range` rollup type identifier. + "averageHeartRateVariabilityMillisecondsMax": 3.14, # The upper bound of the user's average heart rate variability personal range. + "averageHeartRateVariabilityMillisecondsMin": 3.14, # The lower bound of the user's average heart rate variability personal range. + }, + "hydrationLog": { # Represents the result of the rollup of the hydration log data type. # Returned by default when rolling up data points from the `hydration-log` data type, or when requested explicitly using the `hydration-log` rollup type identifier. + "amountConsumed": { # Rollup for volume quantity. # Rollup for amount consumed. + "millilitersSum": 3.14, # Required. The sum of volume in milliliters. + "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element. + }, + }, + "restingHeartRatePersonalRange": { # Represents the rollup value for the daily resting heart rate data type. # Returned by default when rolling up data points from the `daily-resting-heart-rate` data type, or when requested explicitly using the `resting-heart-rate-personal-range` rollup type identifier. + "beatsPerMinuteMax": 3.14, # The upper bound of the user's daily resting heart rate personal range. + "beatsPerMinuteMin": 3.14, # The lower bound of the user's daily resting heart rate personal range. + }, + "runVo2Max": { # Represents the result of the rollup of the user's daily heart rate variability personal range. # Returned by default when rolling up data points from the `run-vo2-max` data type, or when requested explicitly using the `run-vo2-max` rollup type identifier. + "rateAvg": 3.14, # Average value of run VO2 max in the interval. + "rateMax": 3.14, # Maximum value of run VO2 max in the interval. + "rateMin": 3.14, # Minimum value of run VO2 max in the interval.. + }, + "sedentaryPeriod": { # Represents the result of the rollup of the user's sedentary periods. # Returned by default when rolling up data points from the `sedentary-period` data type, or when requested explicitly using the `sedentary-period` rollup type identifier. + "durationSum": "A String", # The total time user spent sedentary during the interval. + }, + "steps": { # Represents the result of the rollup of the steps data type. # Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier. + "countSum": "A String", # Total number of steps in the interval. + }, + "swimLengthsData": { # Represents the result of the rollup of the swim lengths data type. # Returned by default when rolling up data points from the `swim-lengths-data` data type, or when requested explicitly using the `swim-lengths-data` rollup type identifier. + "strokeCountSum": "A String", # Total number of swim strokes in the interval. + }, + "timeInHeartRateZone": { # Represents the result of the rollup of the time in heart rate zone data type. # Returned by default when rolling up data points from the `time-in-heart-rate-zone` data type, or when requested explicitly using the `time-in-heart-rate-zone` rollup type identifier. + "timeInHeartRateZones": [ # List of time spent in each heart rate zone. + { # Represents the total time spent in a specific heart rate zone. + "duration": "A String", # The total time spent in the specified heart rate zone. + "heartRateZone": "A String", # The heart rate zone. + }, + ], + }, + "totalCalories": { # Represents the result of the rollup of the user's total calories. # Returned by default when rolling up data points from the `total-calories` data type, or when requested explicitly using the `total-calories` rollup type identifier. + "kcalSum": 3.14, # Sum of the total calories in kilocalories. + }, + "weight": { # Represents the result of the rollup of the weight data type. # Returned by default when rolling up data points from the `weight` data type, or when requested explicitly using the `weight` rollup type identifier. + "weightGramsAvg": 3.14, # Average weight in grams. + }, + }, + ], +}++ +exportExerciseTcx(name, partialData=None, x__xgafv=None)+Exports exercise data in TCX format. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed. + +Args: + name: string, Required. The resource name of the exercise data point to export. Format: `users/{user}/dataTypes/exercise/dataPoints/{data_point}` Example: `users/me/dataTypes/exercise/dataPoints/2026443605080188808` The `{user}` is the alias `"me"` currently. Future versions may support user IDs. The `{data_point}` ID maps to the exercise ID, which is a long integer. (required) + partialData: boolean, Optional. Indicates whether to include the TCX data points when the GPS data is not available. If not specified, defaults to `false` and partial data will not be included. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents a Response for exporting exercise data in TCX format. + "tcxData": "A String", # Contains the exported TCX data. +}+++ +exportExerciseTcx_media(name, partialData=None, x__xgafv=None)+Exports exercise data in TCX format. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed. + +Args: + name: string, Required. The resource name of the exercise data point to export. Format: `users/{user}/dataTypes/exercise/dataPoints/{data_point}` Example: `users/me/dataTypes/exercise/dataPoints/2026443605080188808` The `{user}` is the alias `"me"` currently. Future versions may support user IDs. The `{data_point}` ID maps to the exercise ID, which is a long integer. (required) + partialData: boolean, Optional. Indicates whether to include the TCX data points when the GPS data is not available. If not specified, defaults to `false` and partial data will not be included. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + The media object as a string. + +++- -get(name, x__xgafv=None)+Get a single identifyable data point. + +Args: + name: string, Required. The name of the data point to retrieve. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` See DataPoint.name for examples and possible values. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A computed or recorded metric. + "activeMinutes": { # Record of active minutes in a given time interval. # Optional. Data for points in the `active-minutes` interval data type collection. + "activeMinutesByActivityLevel": [ # Required. Active minutes by activity level. At most one record per activity level is allowed. + { # Active minutes at a given activity level. + "activeMinutes": "A String", # Required. Number of whole minutes spent in activity. + "activityLevel": "A String", # Required. The level of activity. + }, + ], + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + }, + "activeZoneMinutes": { # Record of active zone minutes in a given time interval. # Optional. Data for points in the `active-zone-minutes` interval data type collection, measured in minutes. + "activeZoneMinutes": "A String", # Required. Number of Active Zone Minutes earned in the given time interval. Note: active_zone_minutes equals to 1 for low intensity (fat burn) zones or 2 for high intensity zones (cardio, peak). + "heartRateZone": "A String", # Required. Heart rate zone in which the active zone minutes have been earned, in the given time interval. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + }, + "activityLevel": { # Internal type to capture activity level during a certain time interval. # Optional. Data for points in the `activity-level` daily data type collection. + "activityLevelType": "A String", # Required. Activity level type in the given time interval. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + }, + "altitude": { # Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters. # Optional. Data for points in the `altitude` interval data type collection. + "gainMillimeters": "A String", # Required. Altitude gain in millimeters over the observed interval. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + }, + "bodyFat": { # Body fat measurement. # Optional. Data for points in the `body-fat` sample data type collection. + "percentage": 3.14, # Required. Body fat percentage, in range [0, 100]. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + }, + "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Optional. Data for points in the `daily-heart-rate-variability` daily data type collection. + "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of heart rate variability measurement. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "deepSleepRootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences (RMSSD) value during deep sleep. + "entropy": 3.14, # Optional. The Shanon entropy of heartbeat intervals. Entropy quantifies randomness or disorder in a system. High entropy indicates high HRV. Entropy is measured from the histogram of time interval between successive heart beats values measured during sleep. + "nonRemHeartRateBeatsPerMinute": "A String", # Optional. Non-REM heart rate + }, + "dailyHeartRateZones": { # User's heart rate zone thresholds based on the Karvonen algorithm for a specific day. # Optional. Data for points in the `daily-heart-rate-zones` daily data type collection. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in user's timezone) of the heart rate zones record. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "heartRateZones": [ # Required. The heart rate zones. + { # The heart rate zone. + "heartRateZoneType": "A String", # Required. The heart rate zone type. + "maxBeatsPerMinute": "A String", # Required. Maximum heart rate for this zone in beats per minute. + "minBeatsPerMinute": "A String", # Required. Minimum heart rate for this zone in beats per minute. + }, + ], + }, + "dailyOxygenSaturation": { # A daily oxygen saturation (SpO2) record. Represents the user's daily oxygen saturation summary, typically calculated during sleep. # Optional. Data for points in the `daily-oxygen-saturation` daily data type collection. + "averagePercentage": 3.14, # Required. The average value of the oxygen saturation samples during the sleep. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in user's timezone) of the daily oxygen saturation record. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "lowerBoundPercentage": 3.14, # Required. The lower bound of the confidence interval of oxygen saturation samples during sleep. + "standardDeviationPercentage": 3.14, # Optional. Standard deviation of the daily oxygen saturation averages from the past 7-30 days. + "upperBoundPercentage": 3.14, # Required. The upper bound of the confidence interval of oxygen saturation samples during sleep. + }, + "dailyRespiratoryRate": { # A daily average respiratory rate (breaths per minute) for a day of the year. One data point per day calculated for the main sleep. # Optional. Data for points in the `daily-respiratory-rate` daily data type collection. + "breathsPerMinute": 3.14, # Required. The average number of breaths taken per minute. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The date on which the respiratory rate was measured. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + }, + "dailyRestingHeartRate": { # Measures the daily resting heart rate for a user, calculated using the all day heart rate measurements. # Optional. Data for points in the `daily-resting-heart-rate` daily data type collection. + "beatsPerMinute": "A String", # Required. The resting heart rate value in beats per minute. + "dailyRestingHeartRateMetadata": { # Metadata for the daily resting heart rate. # Optional. Metadata for the daily resting heart rate. + "calculationMethod": "A String", # Required. The method used to calculate the resting heart rate. + }, + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of the resting heart rate measurement. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + }, + "dailySleepTemperatureDerivations": { # Provides derived sleep temperature values, calculated from skin or internal device temperature readings during sleep. # Optional. Data for points in the `daily-sleep-temperature-derivations` daily data type collection. + "baselineTemperatureCelsius": 3.14, # Optional. The user's baseline skin temperature. It is the median of the user's nightly skin temperature over the past 30 days. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date for which the sleep temperature derivations are calculated. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "nightlyTemperatureCelsius": 3.14, # Required. The user's nightly skin temperature. It is the mean of skin temperature samples taken from the user’s sleep. + "relativeNightlyStddev30dCelsius": 3.14, # Optional. The standard deviation of the user’s relative nightly skin temperature (temperature - baseline) over the past 30 days. + }, + "dailyVo2Max": { # Contains a daily summary of the user's VO2 max (cardio fitness score), which is the maximum rate of oxygen the body can use during exercise. # Optional. Data for points in the `daily-vo2-max` daily data type collection. + "cardioFitnessLevel": "A String", # Optional. Represents the user's cardio fitness level based on their VO2 max. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The date for which the Daily VO2 max was measured. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "estimated": True or False, # Optional. An estimated field is added to indicate when the confidence has decreased sufficiently to consider the value an estimation. + "vo2Max": 3.14, # Required. Daily VO2 max value measured as in ml consumed oxygen / kg of body weight / min. + "vo2MaxCovariance": 3.14, # Optional. The covariance of the VO2 max value. + }, + "dataSource": { # Data Source definition to track the origin of data. Each health data point, regardless of the complexity or data model (whether a simple step count or a detailed sleep session) must retain information about its source of origin (e.g. the device or app that collected it). # Optional. Data source information for the metric + "application": { # Optional metadata for the application that provided this data. # Output only. Captures metadata for the application that provided this data. + "googleWebClientId": "A String", # Output only. The Google OAuth 2.0 client ID of the web application or service that recorded the data. This is the client ID used during the Google OAuth flow to obtain user credentials. This field is system-populated when the data is uploaded from Google Web API. + "packageName": "A String", # Output only. A unique identifier for the mobile application that was the source of the data. This is typically the application's package name on Android (e.g., `com.google.fitbit`) or the bundle ID on iOS. This field is informational and helps trace data origin. This field is system-populated when the data is uploaded from the Fitbit mobile application, Health Connect or Health Kit. + "webClientId": "A String", # Output only. The client ID of the application that recorded the data. This ID is a legacy Fitbit API client ID, which is different from a Google OAuth client ID. Example format: `ABC123`. This field is system-populated and used for tracing data from legacy Fitbit API integrations. This field is system-populated when the data is uploaded from a legacy Fitbit API integration. + }, + "device": { # Captures metadata about the device that recorded the measurement. # Optional. Captures metadata for raw data points originating from devices. We expect this data source to be used for data points written on device sync. + "displayName": "A String", # Optional. An optional name for the device. + "formFactor": "A String", # Optional. Captures the form factor of the device. + "manufacturer": "A String", # Optional. An optional manufacturer of the device. + }, + "platform": "A String", # Output only. Captures the platform that uploaded the data. + "recordingMethod": "A String", # Optional. Captures how the data was recorded. + }, + "distance": { # Distance traveled over an interval of time. # Optional. Data for points in the `distance` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + "millimeters": "A String", # Required. Distance in millimeters over the observed interval. + }, + "exercise": { # An exercise that stores information about a physical activity. # Optional. Data for points in the `exercise` session data type collection. + "activeDuration": "A String", # Optional. Duration excluding pauses. + "createTime": "A String", # Output only. Represents the timestamp of the creation of the exercise. + "displayName": "A String", # Required. Exercise display name. + "exerciseEvents": [ # Optional. Exercise events that happen during an exercise, such as pause & restarts. + { # Represents instantaneous events that happen during an exercise, such as start, stop, pause, split. + "eventTime": "A String", # Required. Exercise event time + "eventUtcOffset": "A String", # Required. Exercise event time offset from UTC + "exerciseEventType": "A String", # Required. The type of the event, such as start, stop, pause, resume. + }, + ], + "exerciseMetadata": { # Additional exercise metadata. # Optional. Additional exercise metadata. + "hasGps": True or False, # Optional. Whether the exercise had GPS tracking. + "poolLengthMillimeters": "A String", # Optional. Pool length in millimeters. Only present in the swimming exercises. + }, + "exerciseType": "A String", # Required. The type of activity performed during an exercise. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed exercise interval + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this exercise ( ) + "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise. + "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise. + "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter. + "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second. + "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise. + "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise. + "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise. + "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone. + "lightTime": "A String", # Optional. Time spent in light heart rate zone. + "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone. + "peakTime": "A String", # Optional. Time spent in peak heart rate zone. + "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone. + }, + "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises. + "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout. + "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride + "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride + "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running + "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0]. + }, + "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise. + "steps": "A String", # Optional. Total steps taken during the exercise. + "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise. + }, + "notes": "A String", # Optional. Standard free-form notes captured at manual logging. + "splitSummaries": [ # Optional. Laps or splits recorded within an exercise. Laps could be split based on distance or other criteria (duration, etc.) Laps should not be overlapping with each other. + { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories. + "activeDuration": "A String", # Output only. Lap time excluding the pauses. + "endTime": "A String", # Required. Lap end time + "endUtcOffset": "A String", # Required. Lap end time offset from UTC + "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split. + "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise. + "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise. + "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter. + "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second. + "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise. + "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise. + "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise. + "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone. + "lightTime": "A String", # Optional. Time spent in light heart rate zone. + "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone. + "peakTime": "A String", # Optional. Time spent in peak heart rate zone. + "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone. + }, + "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises. + "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout. + "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride + "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride + "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running + "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0]. + }, + "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise. + "steps": "A String", # Optional. Total steps taken during the exercise. + "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise. + }, + "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic. + "startTime": "A String", # Required. Lap start time + "startUtcOffset": "A String", # Required. Lap start time offset from UTC + }, + ], + "splits": [ # Optional. The default split is 1 km or 1 mile. - if the movement distance is less than the default, then there are no splits - if the movement distance is greater than or equal to the default, then we have splits + { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories. + "activeDuration": "A String", # Output only. Lap time excluding the pauses. + "endTime": "A String", # Required. Lap end time + "endUtcOffset": "A String", # Required. Lap end time offset from UTC + "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split. + "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise. + "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise. + "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter. + "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second. + "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise. + "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise. + "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise. + "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone. + "lightTime": "A String", # Optional. Time spent in light heart rate zone. + "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone. + "peakTime": "A String", # Optional. Time spent in peak heart rate zone. + "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone. + }, + "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises. + "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout. + "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride + "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride + "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running + "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0]. + }, + "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise. + "steps": "A String", # Optional. Total steps taken during the exercise. + "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise. + }, + "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic. + "startTime": "A String", # Required. Lap start time + "startUtcOffset": "A String", # Required. Lap start time offset from UTC + }, + ], + "updateTime": "A String", # Output only. This is the timestamp of the last update to the exercise. + }, + "floors": { # Gained elevation measured in floors over the time interval # Optional. Data for points in the `floors` interval data type collection. + "count": "A String", # Required. Number of floors in the recorded interval + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + }, + "heartRate": { # A heart rate measurement. # Optional. Data for points in the `heart-rate` sample data type collection. + "beatsPerMinute": "A String", # Required. The heart rate value in beats per minute. + "metadata": { # Heart rate metadata. # Optional. Metadata about the heart rate sample. + "motionContext": "A String", # Optional. Indicates the user’s level of activity when the heart rate sample was measured + "sensorLocation": "A String", # Optional. Indicates the location of the sensor that measured the heart rate. + }, + "sampleTime": { # Represents a sample time of an observed data point. # Required. Observation time + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + }, + "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection. + "rootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Fitbit. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time of the heart rate variability measurement. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "standardDeviationMilliseconds": 3.14, # Optional. The standard deviation of the heart rate variability measurement. + }, + "height": { # Body height measurement. # Optional. Data for points in the `height` sample data type collection. + "heightMillimeters": "A String", # Required. Height of the user in millimeters. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the height was recorded. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + }, + "hydrationLog": { # Holds information about a user logged hydration. # Optional. Data for points in the `hydration-log` session data type collection. + "amountConsumed": { # Represents the volume quantity. # Required. Amount of liquid (ex. water) consumed. + "milliliters": 3.14, # Required. Value representing the volume in milliliters. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + }, + "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the `total_calories` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. + "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. + "percentage": 3.14, # Required. The oxygen saturation percentage. Valid values are from 0 to 100. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which oxygen saturation was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + }, + "respiratoryRateSleepSummary": { # Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times. # Optional. Data for points in the `respiratory-rate-sleep-summary` sample data type collection. + "deepSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for deep sleep. + "breathsPerMinute": 3.14, # Required. Average breaths per minute. + "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation. + "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep. + }, + "fullSleepStats": { # Respiratory rate statistics for a given sleep stage. # Required. Full respiratory rate statistics. + "breathsPerMinute": 3.14, # Required. Average breaths per minute. + "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation. + "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep. + }, + "lightSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for light sleep. + "breathsPerMinute": 3.14, # Required. Average breaths per minute. + "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation. + "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep. + }, + "remSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for REM sleep. + "breathsPerMinute": 3.14, # Required. Average breaths per minute. + "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation. + "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep. + }, + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which respiratory rate was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + }, + "runVo2Max": { # VO2 max value calculated based on the user's running activity. Value stored in ml/kg/min. # Optional. Data for points in the `run-vo2-max` sample data type collection. + "runVo2Max": 3.14, # Required. Run VO2 max value in ml/kg/min. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the metric was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + }, + "sedentaryPeriod": { # SedentaryPeriod SedentaryPeriod data represents the periods of time that the user was sedentary (i.e. not moving while wearing the device). # Optional. Data for points in the `sedentary-period` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + }, + "sleep": { # A sleep session possibly including stages. # Optional. Data for points in the `sleep` session data type collection. + "createTime": "A String", # Output only. Creation time of this sleep observation. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed sleep interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + "metadata": { # Additional information about how the sleep was processed. # Optional. Sleep metadata: processing, main, manually edited, stages status. + "externalId": "A String", # Optional. Sleep identifier relevant in the context of the data source. + "manuallyEdited": True or False, # Output only. Some sleeps autodetected by algorithms can be manually edited by users. + "nap": True or False, # Output only. Naps are sleeps without stages and relatively short durations. + "processed": True or False, # Output only. Sleep and sleep stages algorithms finished processing. + "stagesStatus": "A String", # Output only. Sleep stages algorithm processing status. + }, + "outOfBedSegments": [ # Optional. “Out of bed” segments that can overlap with sleep stages. + { # A time interval to represent an out-of-bed segment. + "endTime": "A String", # Required. Segment end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the segment relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Segment tart time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the segment relative to the Coordinated Universal Time (UTC). + }, + ], + "stages": [ # Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period. + { # Sleep stage segment. + "createTime": "A String", # Output only. Creation time of this sleep stages segment. + "endTime": "A String", # Required. Sleep stage end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Sleep stage start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC). + "type": "A String", # Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc. + "updateTime": "A String", # Output only. Last update time of this sleep stages segment. + }, + ], + "summary": { # Sleep summary: metrics and stages summary. # Output only. Sleep summary: metrics and stages summary. + "minutesAfterWakeUp": "A String", # Output only. Minutes after wake up calculated by restlessness algorithm. + "minutesAsleep": "A String", # Output only. Total number of minutes asleep. For classic sleep it is the sum of ASLEEP stages (excluding AWAKE and RESTLESS). For "stages" sleep it is the sum of LIGHT, REM and DEEP stages (excluding AWAKE). + "minutesAwake": "A String", # Output only. Total number of minutes awake. It is a sum of all AWAKE stages. + "minutesInSleepPeriod": "A String", # Output only. Delta between wake time and bedtime. It is the sum of all stages. + "minutesToFallAsleep": "A String", # Output only. Minutes to fall asleep calculated by restlessness algorithm. + "stagesSummary": [ # Output only. List of summaries (total duration and segment count) per each sleep stage type. + { # Total duration and segment count for a stage. + "count": "A String", # Output only. Number of sleep stages segments. + "minutes": "A String", # Output only. Total duration in minutes of a sleep stage. + "type": "A String", # Output only. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc. + }, + ], + }, + "type": "A String", # Optional. SleepType: classic or stages. + "updateTime": "A String", # Output only. Last update time of this sleep observation. + }, + "steps": { # Step count over the time interval. # Optional. Data for points in the `steps` interval data type collection. + "count": "A String", # Required. Number of steps in the recorded interval. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + }, + "swimLengthsData": { # Swim lengths data over the time interval. # Optional. Data for points in the `swim-lengths-data` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + "strokeCount": "A String", # Required. Number of strokes in the lap. + "swimStrokeType": "A String", # Required. Swim stroke type. + }, + "timeInHeartRateZone": { # Time in heart rate zone record. It's an interval spent in specific heart rate zone. # Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection. + "heartRateZoneType": "A String", # Required. Heart rate zone type. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + }, + "vo2Max": { # VO2 max measurement. # Optional. Data for points in the `vo2-max` sample data type collection. + "measurementMethod": "A String", # Optional. The method used to measure the VO2 max value. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which VO2 max was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "vo2Max": 3.14, # Required. VO2 max value measured as in ml consumed oxygen / kg of body weight / min. + }, + "weight": { # Body weight measurement. # Optional. Data for points in the `weight` sample data type collection. + "notes": "A String", # Optional. Standard free-form notes captured at manual logging. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the weight was measured + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -1178,99 +2257,14 @@-Method Details
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, - "distance": { # Result of the rollup of the user's distance. # Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier. - "millimetersSum": "A String", # Sum of the distance in millimeters. - }, - "floors": { # Represents the result of the rollup of the user's floors. # Returned by default when rolling up data points from the `floors` data type, or when requested explicitly using the `floors` rollup type identifier. - "countSum": "A String", # Sum of the floors count. - }, - "heartRate": { # Represents the result of the rollup of the heart rate data type. # Returned by default when rolling up data points from the `heart-rate` data type, or when requested explicitly using the `heart-rate` rollup type identifier. - "beatsPerMinuteAvg": 3.14, # The average heart rate value in the interval. - "beatsPerMinuteMax": 3.14, # The maximum heart rate value in the interval. - "beatsPerMinuteMin": 3.14, # The minimum heart rate value in the interval. - }, - "heartRateVariabilityPersonalRange": { # Represents the result of the rollup of the user's daily heart rate variability personal range. # Returned by default when rolling up data points from the `daily-heart-rate-variability` data type, or when requested explicitly using the `heart-rate-variability-personal-range` rollup type identifier. - "averageHeartRateVariabilityMillisecondsMax": 3.14, # The upper bound of the user's average heart rate variability personal range. - "averageHeartRateVariabilityMillisecondsMin": 3.14, # The lower bound of the user's average heart rate variability personal range. - }, - "hydrationLog": { # Represents the result of the rollup of the hydration log data type. # Returned by default when rolling up data points from the `hydration-log` data type, or when requested explicitly using the `hydration-log` rollup type identifier. - "amountConsumed": { # Rollup for volume quantity. # Rollup for amount consumed. - "millilitersSum": 3.14, # Required. The sum of volume in milliliters. - "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element. - }, - }, - "restingHeartRatePersonalRange": { # Represents the rollup value for the daily resting heart rate data type. # Returned by default when rolling up data points from the `daily-resting-heart-rate` data type, or when requested explicitly using the `resting-heart-rate-personal-range` rollup type identifier. - "beatsPerMinuteMax": 3.14, # The upper bound of the user's daily resting heart rate personal range. - "beatsPerMinuteMin": 3.14, # The lower bound of the user's daily resting heart rate personal range. - }, - "runVo2Max": { # Represents the result of the rollup of the user's daily heart rate variability personal range. # Returned by default when rolling up data points from the `run-vo2-max` data type, or when requested explicitly using the `run-vo2-max` rollup type identifier. - "rateAvg": 3.14, # Average value of run VO2 max in the interval. - "rateMax": 3.14, # Maximum value of run VO2 max in the interval. - "rateMin": 3.14, # Minimum value of run VO2 max in the interval.. - }, - "sedentaryPeriod": { # Represents the result of the rollup of the user's sedentary periods. # Returned by default when rolling up data points from the `sedentary-period` data type, or when requested explicitly using the `sedentary-period` rollup type identifier. - "durationSum": "A String", # The total time user spent sedentary during the interval. - }, - "steps": { # Represents the result of the rollup of the steps data type. # Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier. - "countSum": "A String", # Total number of steps in the interval. - }, - "timeInHeartRateZone": { # Represents the result of the rollup of the time in heart rate zone data type. # Returned by default when rolling up data points from the `time-in-heart-rate-zone` data type, or when requested explicitly using the `time-in-heart-rate-zone` rollup type identifier. - "timeInHeartRateZones": [ # List of time spent in each heart rate zone. - { # Represents the total time spent in a specific heart rate zone. - "duration": "A String", # The total time spent in the specified heart rate zone. - "heartRateZone": "A String", # The heart rate zone. - }, - ], - }, - "totalCalories": { # Represents the result of the rollup of the user's total calories. # Returned by default when rolling up data points from the `total-calories` data type, or when requested explicitly using the `total-calories` rollup type identifier. - "kcalSum": 3.14, # Sum of the total calories in kilocalories. - }, - "weight": { # Represents the result of the rollup of the weight data type. # Returned by default when rolling up data points from the `weight` data type, or when requested explicitly using the `weight` rollup type identifier. - "weightGramsAvg": 3.14, # Average weight in grams. - }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). }, - ], -}--exportExerciseTcx(name, partialData=None, x__xgafv=None)-Exports exercise data in TCX format. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed. - -Args: - name: string, Required. The resource name of the exercise data point to export. Format: `users/{user}/dataTypes/exercise/dataPoints/{data_point}` Example: `users/me/dataTypes/exercise/dataPoints/2026443605080188808` The `{user}` is the alias `"me"` currently. Future versions may support user IDs. The `{data_point}` ID maps to the exercise ID, which is a long integer. (required) - partialData: boolean, Optional. Indicates whether to include the TCX data points when the GPS data is not available. If not specified, defaults to `false` and partial data will not be included. - x__xgafv: string, V1 error format. - Allowed values - 1 - v1 error format - 2 - v2 error format - -Returns: - An object of the form: - - { # Represents a Response for exporting exercise data in TCX format. - "tcxData": "A String", # Contains the exported TCX data. + "weightGrams": 3.14, # Required. Weight of a user in grams. + }, }--exportExerciseTcx_media(name, partialData=None, x__xgafv=None)-Exports exercise data in TCX format. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed. - -Args: - name: string, Required. The resource name of the exercise data point to export. Format: `users/{user}/dataTypes/exercise/dataPoints/{data_point}` Example: `users/me/dataTypes/exercise/dataPoints/2026443605080188808` The `{user}` is the alias `"me"` currently. Future versions may support user IDs. The `{data_point}` ID maps to the exercise ID, which is a long integer. (required) - partialData: boolean, Optional. Indicates whether to include the TCX data points when the GPS data is not available. If not specified, defaults to `false` and partial data will not be included. - x__xgafv: string, V1 error format. - Allowed values - 1 - v1 error format - 2 - v2 error format - -Returns: - The media object as a string. - --list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Query user health and fitness data points. @@ -1808,6 +2802,26 @@Method Details
}, "standardDeviationMilliseconds": 3.14, # Optional. The standard deviation of the heart rate variability measurement. }, + "height": { # Body height measurement. # Optional. Data for points in the `height` sample data type collection. + "heightMillimeters": "A String", # Required. Height of the user in millimeters. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the height was recorded. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + }, "hydrationLog": { # Holds information about a user logged hydration. # Optional. Data for points in the `hydration-log` session data type collection. "amountConsumed": { # Represents the volume quantity. # Required. Amount of liquid (ex. water) consumed. "milliliters": 3.14, # Required. Value representing the volume in milliliters. @@ -2072,6 +3086,42 @@Method Details
"startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). }, }, + "swimLengthsData": { # Swim lengths data over the time interval. # Optional. Data for points in the `swim-lengths-data` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + "strokeCount": "A String", # Required. Number of strokes in the lap. + "swimStrokeType": "A String", # Required. Swim stroke type. + }, "timeInHeartRateZone": { # Time in heart rate zone record. It's an interval spent in specific heart rate zone. # Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection. "heartRateZoneType": "A String", # Required. Heart rate zone type. "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. @@ -2696,6 +3746,26 @@Method Details
}, "standardDeviationMilliseconds": 3.14, # Optional. The standard deviation of the heart rate variability measurement. }, + "height": { # Body height measurement. # Optional. Data for points in the `height` sample data type collection. + "heightMillimeters": "A String", # Required. Height of the user in millimeters. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the height was recorded. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + }, "hydrationLog": { # Holds information about a user logged hydration. # Optional. Data for points in the `hydration-log` session data type collection. "amountConsumed": { # Represents the volume quantity. # Required. Amount of liquid (ex. water) consumed. "milliliters": 3.14, # Required. Value representing the volume in milliliters. @@ -2960,6 +4030,42 @@Method Details
"startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). }, }, + "swimLengthsData": { # Swim lengths data over the time interval. # Optional. Data for points in the `swim-lengths-data` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + "strokeCount": "A String", # Required. Number of strokes in the lap. + "swimStrokeType": "A String", # Required. Swim stroke type. + }, "timeInHeartRateZone": { # Time in heart rate zone record. It's an interval spent in specific heart rate zone. # Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection. "heartRateZoneType": "A String", # Required. Heart rate zone type. "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. @@ -3593,6 +4699,26 @@Method Details
}, "standardDeviationMilliseconds": 3.14, # Optional. The standard deviation of the heart rate variability measurement. }, + "height": { # Body height measurement. # Data for points in the `height` sample data type collection. + "heightMillimeters": "A String", # Required. Height of the user in millimeters. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the height was recorded. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + }, "hydrationLog": { # Holds information about a user logged hydration. # Data for points in the `hydration-log` session data type collection. "amountConsumed": { # Represents the volume quantity. # Required. Amount of liquid (ex. water) consumed. "milliliters": 3.14, # Required. Value representing the volume in milliliters. @@ -3856,6 +4982,42 @@Method Details
"startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). }, }, + "swimLengthsData": { # Swim lengths data over the time interval. # Data for points in the `swim-lengths-data` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + "strokeCount": "A String", # Required. Number of strokes in the lap. + "swimStrokeType": "A String", # Required. Swim stroke type. + }, "timeInHeartRateZone": { # Time in heart rate zone record. It's an interval spent in specific heart rate zone. # Data for points in the `time-in-heart-rate-zone` interval data type collection. "heartRateZoneType": "A String", # Required. Heart rate zone type. "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. @@ -4050,6 +5212,9 @@Method Details
"steps": { # Represents the result of the rollup of the steps data type. # Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier. "countSum": "A String", # Total number of steps in the interval. }, + "swimLengthsData": { # Represents the result of the rollup of the swim lengths data type. # Returned by default when rolling up data points from the `swim-lengths-data` data type, or when requested explicitly using the `swim-lengths-data` rollup type identifier. + "strokeCountSum": "A String", # Total number of swim strokes in the interval. + }, "timeInHeartRateZone": { # Represents the result of the rollup of the time in heart rate zone data type. # Returned by default when rolling up data points from the `time-in-heart-rate-zone` data type, or when requested explicitly using the `time-in-heart-rate-zone` rollup type identifier. "timeInHeartRateZones": [ # List of time spent in each heart rate zone. { # Represents the total time spent in a specific heart rate zone. diff --git a/googleapiclient/discovery_cache/documents/health.v4.json b/googleapiclient/discovery_cache/documents/health.v4.json index f3a3dfaf21..cb67514153 100644 --- a/googleapiclient/discovery_cache/documents/health.v4.json +++ b/googleapiclient/discovery_cache/documents/health.v4.json @@ -1,4 +1,13 @@ { +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/cloud-platform": { +"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +} +} +} +}, "basePath": "", "baseUrl": "https://health.googleapis.com/", "batchPath": "batch", @@ -96,6 +105,147 @@ }, "protocol": "rest", "resources": { +"projects": { +"resources": { +"subscribers": { +"methods": { +"create": { +"description": "Registers a new subscriber endpoint to receive notifications. A subscriber represents an application or service that wishes to receive data change notifications for users who have granted consent. **Endpoint Verification:** For a subscriber to be successfully created, the provided `endpoint_uri` must be a valid HTTPS endpoint and must pass an automated verification check. The backend will send two HTTP POST requests to the `endpoint_uri`: 1. **Verification with Authorization:** * **Headers:** Includes `Content-Type: application/json` and `Authorization` (with the exact value from `CreateSubscriberPayload.endpoint_authorization.secret`). * **Body:** `{\"type\": \"verification\"}` * **Expected Response:** HTTP `201 Created`. 2. **Verification without Authorization:** * **Headers:** Includes `Content-Type: application/json`. The `Authorization` header is OMITTED. * **Body:** `{\"type\": \"verification\"}` * **Expected Response:** HTTP `401 Unauthorized` or `403 Forbidden`. Both tests must pass for the subscriber creation to succeed. If verification fails, the operation will not be completed and an error will be returned. This process ensures the endpoint is reachable and correctly validates the `Authorization` header.", +"flatPath": "v4/projects/{projectsId}/subscribers", +"httpMethod": "POST", +"id": "health.projects.subscribers.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource where this subscriber will be created. Format: projects/{project} Example: projects/my-project-123", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"subscriberId": { +"description": "Optional. The ID to use for the subscriber, which will become the final component of the subscriber's resource name. This value should be 4-36 characters, and valid characters are /[a-z]([a-z0-9-]{2,34}[a-z0-9])/.", +"location": "query", +"type": "string" +} +}, +"path": "v4/{+parent}/subscribers", +"request": { +"$ref": "CreateSubscriberPayload" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a subscriber registration. This will stop all notifications to the subscriber's endpoint.", +"flatPath": "v4/projects/{projectsId}/subscribers/{subscribersId}", +"httpMethod": "DELETE", +"id": "health.projects.subscribers.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "Optional. If set to true, any child resources (e.g., subscriptions) will also be deleted. If false (default) and child resources exist, the request will fail.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. The name of the subscriber to delete. Format: projects/{project}/subscribers/{subscriber} Example: projects/my-project/subscribers/my-subscriber-123 The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated if not provided during creation.", +"location": "path", +"pattern": "^projects/[^/]+/subscribers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all subscribers registered within the owned Google Cloud Project.", +"flatPath": "v4/projects/{projectsId}/subscribers", +"httpMethod": "GET", +"id": "health.projects.subscribers.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of subscribers to return. The service may return fewer than this value. If unspecified, at most 50 subscribers will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent, which owns this collection of subscribers. Format: projects/{project}", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+parent}/subscribers", +"response": { +"$ref": "ListSubscribersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the configuration of an existing subscriber, such as the endpoint URI or the data types it's interested in. **Endpoint Verification:** If the `endpoint_uri` or `endpoint_authorization` field is included in the `update_mask`, the backend will re-verify the endpoint. The verification process is the same as described in `CreateSubscriber`: 1. **Verification with Authorization:** POST to the new or existing `endpoint_uri` with the new or existing `Authorization` secret. Expects HTTP `201 Created`. 2. **Verification without Authorization:** POST to the `endpoint_uri` without the `Authorization` header. Expects HTTP `401 Unauthorized` or `403 Forbidden`. Both tests must pass using the potentially updated values for the subscriber update to succeed. If verification fails, the update will not be applied, and an error will be returned.", +"flatPath": "v4/projects/{projectsId}/subscribers/{subscribersId}", +"httpMethod": "PATCH", +"id": "health.projects.subscribers.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the Subscriber. Format: projects/{project}/subscribers/{subscriber} The {project} ID is a Google Cloud Project ID or Project Number. The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise (e.g., a UUID). Example (User-settable subscriber ID): projects/my-project/subscribers/my-sub-123 Example (System-generated subscriber ID): projects/my-project/subscribers/a1b2c3d4-e5f6-7890-1234-567890abcdef", +"location": "path", +"pattern": "^projects/[^/]+/subscribers/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. A field mask that specifies which fields of the Subscriber message are to be updated. This allows for partial updates. Supported fields: - endpoint_uri - subscriber_configs - endpoint_authorization", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/{+name}", +"request": { +"$ref": "Subscriber" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "users": { "methods": { "getIdentity": { @@ -336,6 +486,28 @@ "supportsMediaDownload": true, "useMediaDownloadService": true }, +"get": { +"description": "Get a single identifyable data point.", +"flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}", +"httpMethod": "GET", +"id": "health.users.dataTypes.dataPoints.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the data point to retrieve. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` See DataPoint.name for examples and possible values.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+/dataPoints/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+name}", +"response": { +"$ref": "DataPoint" +} +}, "list": { "description": "Query user health and fitness data points.", "flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints", @@ -474,7 +646,7 @@ } } }, -"revision": "20260405", +"revision": "20260416", "rootUrl": "https://health.googleapis.com/", "schemas": { "ActiveMinutes": { @@ -858,6 +1030,28 @@ }, "type": "object" }, +"CreateSubscriberPayload": { +"description": "Payload for creating a subscriber.", +"id": "CreateSubscriberPayload", +"properties": { +"endpointAuthorization": { +"$ref": "EndpointAuthorization", +"description": "Required. Authorization mechanism for the subscriber endpoint. The `secret` within this message is crucial for endpoint verification and for securing webhook notifications." +}, +"endpointUri": { +"description": "Required. The full HTTPS URI where update notifications will be sent. The URI must be a valid URL and use HTTPS as the scheme. This endpoint will be verified during the `CreateSubscriber` call. See CreateSubscriber RPC documentation for verification details.", +"type": "string" +}, +"subscriberConfigs": { +"description": "Optional. Configuration for the subscriber.", +"items": { +"$ref": "SubscriberConfig" +}, +"type": "array" +} +}, +"type": "object" +}, "DailyHeartRateVariability": { "description": "Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds`", "id": "DailyHeartRateVariability", @@ -1110,6 +1304,10 @@ "$ref": "StepsRollupValue", "description": "Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier." }, +"swimLengthsData": { +"$ref": "SwimLengthsDataRollupValue", +"description": "Returned by default when rolling up data points from the `swim-lengths-data` data type, or when requested explicitly using the `swim-lengths-data` rollup type identifier." +}, "timeInHeartRateZone": { "$ref": "TimeInHeartRateZoneRollupValue", "description": "Returned by default when rolling up data points from the `time-in-heart-rate-zone` data type, or when requested explicitly using the `time-in-heart-rate-zone` rollup type identifier." @@ -1274,6 +1472,10 @@ "$ref": "HeartRateVariability", "description": "Optional. Data for points in the `heart-rate-variability` sample data type collection." }, +"height": { +"$ref": "Height", +"description": "Optional. Data for points in the `height` sample data type collection." +}, "hydrationLog": { "$ref": "HydrationLog", "description": "Optional. Data for points in the `hydration-log` session data type collection." @@ -1306,6 +1508,10 @@ "$ref": "Steps", "description": "Optional. Data for points in the `steps` interval data type collection." }, +"swimLengthsData": { +"$ref": "SwimLengthsData", +"description": "Optional. Data for points in the `swim-lengths-data` interval data type collection." +}, "timeInHeartRateZone": { "$ref": "TimeInHeartRateZone", "description": "Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection." @@ -1528,6 +1734,22 @@ }, "type": "object" }, +"EndpointAuthorization": { +"description": "Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `X-HEALTHAPI-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API.", +"id": "EndpointAuthorization", +"properties": { +"secret": { +"description": "Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the \"Authorization\" header. The value must include the authorization scheme, e.g., \"Bearer \" or \"Basic \", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during `CreateSubscriber` and `UpdateSubscriber` calls, and will be sent in the `Authorization` header for all subsequent webhook notifications to this endpoint.", +"type": "string" +}, +"secretSet": { +"description": "Output only. Whether the secret is set.", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, "Exercise": { "description": "An exercise that stores information about a physical activity.", "id": "Exercise", @@ -1890,6 +2112,65 @@ }, "type": "object" }, +"Height": { +"description": "Body height measurement.", +"id": "Height", +"properties": { +"heightMillimeters": { +"description": "Required. Height of the user in millimeters.", +"format": "int64", +"type": "string" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which the height was recorded." +} +}, +"type": "object" +}, +"HttpHeader": { +"description": "Represents an HTTP header.", +"id": "HttpHeader", +"properties": { +"key": { +"description": "The HTTP header key. It is case insensitive.", +"type": "string" +}, +"value": { +"description": "The HTTP header value.", +"type": "string" +} +}, +"type": "object" +}, +"HttpResponse": { +"description": "Represents an HTTP response.", +"id": "HttpResponse", +"properties": { +"body": { +"description": "The HTTP response body. If the body is not expected, it should be empty.", +"format": "byte", +"type": "string" +}, +"headers": { +"description": "The HTTP response headers. The ordering of the headers is significant. Multiple headers with the same key may present for the response.", +"items": { +"$ref": "HttpHeader" +}, +"type": "array" +}, +"reason": { +"description": "The HTTP reason phrase, such as \"OK\" or \"Not Found\".", +"type": "string" +}, +"status": { +"description": "The HTTP status code, such as 200 or 404.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "HydrationLog": { "description": "Holds information about a user logged hydration.", "id": "HydrationLog", @@ -1972,6 +2253,29 @@ }, "type": "object" }, +"ListSubscribersResponse": { +"description": "Response message for ListSubscribers.", +"id": "ListSubscribersResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"subscribers": { +"description": "Subscribers from the specified project.", +"items": { +"$ref": "Subscriber" +}, +"type": "array" +}, +"totalSize": { +"description": "The total number of subscribers matching the request.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "MetricsSummary": { "description": "Summary metrics for an exercise.", "id": "MetricsSummary", @@ -2343,6 +2647,10 @@ "$ref": "HeartRateVariability", "description": "Data for points in the `heart-rate-variability` sample data type collection." }, +"height": { +"$ref": "Height", +"description": "Data for points in the `height` sample data type collection." +}, "hydrationLog": { "$ref": "HydrationLog", "description": "Data for points in the `hydration-log` session data type collection." @@ -2371,6 +2679,10 @@ "$ref": "Steps", "description": "Data for points in the `steps` interval data type collection." }, +"swimLengthsData": { +"$ref": "SwimLengthsData", +"description": "Data for points in the `swim-lengths-data` interval data type collection." +}, "timeInHeartRateZone": { "$ref": "TimeInHeartRateZone", "description": "Data for points in the `time-in-heart-rate-zone` interval data type collection." @@ -2565,6 +2877,10 @@ "$ref": "StepsRollupValue", "description": "Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier." }, +"swimLengthsData": { +"$ref": "SwimLengthsDataRollupValue", +"description": "Returned by default when rolling up data points from the `swim-lengths-data` data type, or when requested explicitly using the `swim-lengths-data` rollup type identifier." +}, "timeInHeartRateZone": { "$ref": "TimeInHeartRateZoneRollupValue", "description": "Returned by default when rolling up data points from the `time-in-heart-rate-zone` data type, or when requested explicitly using the `time-in-heart-rate-zone` rollup type identifier." @@ -3213,6 +3529,135 @@ }, "type": "object" }, +"Subscriber": { +"description": "-- Resource Messages -- A subscriber receives notifications from Google Health API.", +"id": "Subscriber", +"properties": { +"createTime": { +"description": "Output only. The time at which the subscriber was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endpointAuthorization": { +"$ref": "EndpointAuthorization", +"description": "Required. Authorization mechanism for a subscriber endpoint. This is required to ensure the endpoint can be verified." +}, +"endpointUri": { +"description": "Required. The full HTTPS URI where update notifications will be sent. The URI must be a valid URL and use HTTPS as the scheme. This endpoint will be verified during CreateSubscriber and UpdateSubscriber calls. See RPC documentation for verification details.", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the Subscriber. Format: projects/{project}/subscribers/{subscriber} The {project} ID is a Google Cloud Project ID or Project Number. The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise (e.g., a UUID). Example (User-settable subscriber ID): projects/my-project/subscribers/my-sub-123 Example (System-generated subscriber ID): projects/my-project/subscribers/a1b2c3d4-e5f6-7890-1234-567890abcdef", +"type": "string" +}, +"state": { +"description": "Output only. The state of the subscriber.", +"enum": [ +"STATE_UNSPECIFIED", +"UNVERIFIED", +"ACTIVE", +"INACTIVE" +], +"enumDescriptions": [ +"Represents an unspecified subscriber state.", +"Represents an unverified subscriber. This is the initial state of the subscriber when it is created. The backend will verify the subscriber's endpoint_uri.", +"Represents an active subscriber. The endpoint has been verified.", +"Represents an inactive subscriber." +], +"readOnly": true, +"type": "string" +}, +"subscriberConfigs": { +"description": "Optional. Configuration for the subscriber.", +"items": { +"$ref": "SubscriberConfig" +}, +"type": "array" +}, +"updateTime": { +"description": "Output only. The time at which the subscriber was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SubscriberConfig": { +"description": "Configuration for a subscriber. A notification is sent to a subscription ONLY if the subscriber has a config for the data type.", +"id": "SubscriberConfig", +"properties": { +"dataTypes": { +"description": "Required. Supported data types are: \"altitude\", \"distance\", \"floors\", \"sleep\", \"steps\", \"weight\". Values should be in kebab-case.", +"items": { +"type": "string" +}, +"type": "array" +}, +"subscriptionCreatePolicy": { +"description": "Required. Policy for subscription creation.", +"enum": [ +"SUBSCRIPTION_CREATE_POLICY_UNSPECIFIED", +"AUTOMATIC", +"MANUAL" +], +"enumDescriptions": [ +"Represents an unspecified policy.", +"When using `AUTOMATIC`, individual subscriptions are not created or stored. Instead, eligibility for notifications is computed dynamically. When a data update occurs for a given data type, notifications are sent to all subscribers with an `AUTOMATIC` policy for that data type, provided the user has granted the necessary consents. This means you do not need to call `CreateSubscription` for each user; notifications are managed automatically based on user consents. As `Subscription` resources are not stored, they cannot be retrieved or managed through `GetSubscription`, `ListSubscriptions`, `UpdateSubscription`, or `DeleteSubscription`.", +"Requires subscriptions to be created manually for new users. The developer needs to call CreateSubscription for new users." +], +"type": "string" +} +}, +"type": "object" +}, +"SwimLengthsData": { +"description": "Swim lengths data over the time interval.", +"id": "SwimLengthsData", +"properties": { +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +}, +"strokeCount": { +"description": "Required. Number of strokes in the lap.", +"format": "int64", +"type": "string" +}, +"swimStrokeType": { +"description": "Required. Swim stroke type.", +"enum": [ +"SWIM_STROKE_TYPE_UNSPECIFIED", +"FREESTYLE", +"BACKSTROKE", +"BREASTSTROKE", +"BUTTERFLY" +], +"enumDescriptions": [ +"Swim stroke type is unspecified.", +"Freestyle swim stroke type.", +"Backstroke swim stroke type.", +"Breaststroke swim stroke type.", +"Butterfly swim stroke type." +], +"type": "string" +} +}, +"type": "object" +}, +"SwimLengthsDataRollupValue": { +"description": "Represents the result of the rollup of the swim lengths data type.", +"id": "SwimLengthsDataRollupValue", +"properties": { +"strokeCountSum": { +"description": "Total number of swim strokes in the interval.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "TimeInHeartRateZone": { "description": "Time in heart rate zone record. It's an interval spent in specific heart rate zone.", "id": "TimeInHeartRateZone", @@ -3491,6 +3936,17 @@ }, "type": "object" }, +"WebhookNotificationCloudLog": { +"description": "Log message for a webhook notification sent by the Google Health API to a subscriber's endpoint. Includes the HTTP response received from the endpoint.", +"id": "WebhookNotificationCloudLog", +"properties": { +"httpResponse": { +"$ref": "HttpResponse", +"description": "Required. Represents the HTTP response. This message includes the status code, reason phrase, headers, and body." +} +}, +"type": "object" +}, "Weight": { "description": "Body weight measurement.", "id": "Weight", From 9922e9248e0f4a411a86f7774a5192f37084974c Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 21 Apr 2026 07:41:56 +0000 Subject: [PATCH 12/18] feat(homegraph): update the api #### homegraph:v1 The following keys were added: - schemas.ComponentTraitUpdates (Total Keys: 5) - schemas.EventData (Total Keys: 7) - schemas.Events (Total Keys: 5) - schemas.HomeEvents (Total Keys: 5) - schemas.HomeTraitUpdates (Total Keys: 5) - schemas.ReportStateAndNotificationDevice.properties.homeEvents (Total Keys: 2) - schemas.ReportStateAndNotificationDevice.properties.homeTraits (Total Keys: 2) - schemas.TraitData (Total Keys: 4) --- docs/dyn/homegraph_v1.devices.html | 36 +++++ .../documents/homegraph.v1.json | 127 +++++++++++++++++- 2 files changed, 162 insertions(+), 1 deletion(-) diff --git a/docs/dyn/homegraph_v1.devices.html b/docs/dyn/homegraph_v1.devices.html index 68f16095e7..e6d8566536 100644 --- a/docs/dyn/homegraph_v1.devices.html +++ b/docs/dyn/homegraph_v1.devices.html @@ -153,6 +153,42 @@ Method Details
"followUpToken": "A String", # Deprecated. "payload": { # Payload containing the state and notification information for devices. # Required. State of devices to update and notification metadata for devices. "devices": { # The states and notifications specific to a device. # The devices for updating state and sending notifications. + "homeEvents": [ # Optional. UDDM/WHDM trait events + { # Contains the set of events for an item. + "deviceId": "A String", # Required. / Unique identifier for the device. + "events": [ # Required. List of events for the item. + { # Contains a set of events for a specific component. + "componentId": "A String", # Optional. The ID of the provider component if the events are associated with a specific component. Optional for WHDM events, required for UDDM events. + "events": [ # Required. List of events associated with the component. + { # Contains the details for a single event. + "event": { # Required. The actual event payload. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "eventId": "A String", # Required. The unique event ID from the device provider. + "eventTime": "A String", # Required. The timestamp of the event. + }, + ], + }, + ], + }, + ], + "homeTraits": [ # Optional. UDDM/WHDM trait updates. + { # Contains the set of updates for a device. + "components": [ # Required. Trait updates for each component. + { # Contains the set of updates for a component. + "componentId": "A String", # Required. ID of the component from the device provider. + "traitData": [ # Required. The updated trait data for the component. + { # Contains the trait payload for a single trait. + "trait": { # Optional. The Home API trait payload. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + }, + ], + }, + ], + "deviceId": "A String", # Required. Unique identifier for the device. + }, + ], "notifications": { # Notifications metadata for devices. See the **Device NOTIFICATIONS** section of the individual trait [reference guides](https://developers.home.google.com/cloud-to-cloud/traits). "a_key": "", # Properties of the object. }, diff --git a/googleapiclient/discovery_cache/documents/homegraph.v1.json b/googleapiclient/discovery_cache/documents/homegraph.v1.json index cb9cc213bb..dbdbf81886 100644 --- a/googleapiclient/discovery_cache/documents/homegraph.v1.json +++ b/googleapiclient/discovery_cache/documents/homegraph.v1.json @@ -216,7 +216,7 @@ } } }, -"revision": "20250716", +"revision": "20260414", "rootUrl": "https://homegraph.googleapis.com/", "schemas": { "AgentDeviceId": { @@ -245,6 +245,24 @@ }, "type": "object" }, +"ComponentTraitUpdates": { +"description": "Contains the set of updates for a component.", +"id": "ComponentTraitUpdates", +"properties": { +"componentId": { +"description": "Required. ID of the component from the device provider.", +"type": "string" +}, +"traitData": { +"description": "Required. The updated trait data for the component.", +"items": { +"$ref": "TraitData" +}, +"type": "array" +} +}, +"type": "object" +}, "Device": { "description": "Third-party device definition.", "id": "Device", @@ -368,6 +386,84 @@ "properties": {}, "type": "object" }, +"EventData": { +"description": "Contains the details for a single event.", +"id": "EventData", +"properties": { +"event": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Required. The actual event payload.", +"type": "object" +}, +"eventId": { +"description": "Required. The unique event ID from the device provider.", +"type": "string" +}, +"eventTime": { +"description": "Required. The timestamp of the event.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"Events": { +"description": "Contains a set of events for a specific component.", +"id": "Events", +"properties": { +"componentId": { +"description": "Optional. The ID of the provider component if the events are associated with a specific component. Optional for WHDM events, required for UDDM events.", +"type": "string" +}, +"events": { +"description": "Required. List of events associated with the component.", +"items": { +"$ref": "EventData" +}, +"type": "array" +} +}, +"type": "object" +}, +"HomeEvents": { +"description": "Contains the set of events for an item.", +"id": "HomeEvents", +"properties": { +"deviceId": { +"description": "Required. / Unique identifier for the device.", +"type": "string" +}, +"events": { +"description": "Required. List of events for the item.", +"items": { +"$ref": "Events" +}, +"type": "array" +} +}, +"type": "object" +}, +"HomeTraitUpdates": { +"description": "Contains the set of updates for a device.", +"id": "HomeTraitUpdates", +"properties": { +"components": { +"description": "Required. Trait updates for each component.", +"items": { +"$ref": "ComponentTraitUpdates" +}, +"type": "array" +}, +"deviceId": { +"description": "Required. Unique identifier for the device.", +"type": "string" +} +}, +"type": "object" +}, "QueryRequest": { "description": "Request type for the [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call.", "id": "QueryRequest", @@ -452,6 +548,20 @@ "description": "The states and notifications specific to a device.", "id": "ReportStateAndNotificationDevice", "properties": { +"homeEvents": { +"description": "Optional. UDDM/WHDM trait events", +"items": { +"$ref": "HomeEvents" +}, +"type": "array" +}, +"homeTraits": { +"description": "Optional. UDDM/WHDM trait updates.", +"items": { +"$ref": "HomeTraitUpdates" +}, +"type": "array" +}, "notifications": { "additionalProperties": { "description": "Properties of the object.", @@ -589,6 +699,21 @@ } }, "type": "object" +}, +"TraitData": { +"description": "Contains the trait payload for a single trait.", +"id": "TraitData", +"properties": { +"trait": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Optional. The Home API trait payload.", +"type": "object" +} +}, +"type": "object" } }, "servicePath": "", From 939be4dbd55528ec1093f7abe04de5d833cc98a6 Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 21 Apr 2026 07:41:56 +0000 Subject: [PATCH 13/18] feat(merchantapi): update the api #### merchantapi:products_v1 The following keys were added: - schemas.ProductAttributes.properties.minimumOrderValues (Total Keys: 2) - schemas.ProductAttributes.properties.videoLinks (Total Keys: 2) - schemas.ProductInstallment.properties.annualPercentageRate (Total Keys: 2) - schemas.ProductMinimumOrderValue (Total Keys: 6) - schemas.Shipping.properties.loyaltyProgramLabel.type (Total Keys: 1) - schemas.Shipping.properties.loyaltyTierLabel.type (Total Keys: 1) #### merchantapi:products_v1beta The following keys were added: - schemas.Shipping.properties.loyaltyProgramLabel.type (Total Keys: 1) - schemas.Shipping.properties.loyaltyTierLabel.type (Total Keys: 1) --- .../dyn/merchantapi_accounts_v1.accounts.html | 18 ++-- ...hantapi_accounts_v1.accounts.programs.html | 8 +- .../merchantapi_accounts_v1beta.accounts.html | 18 ++-- ...api_accounts_v1beta.accounts.programs.html | 8 +- ...pi_products_v1.accounts.productInputs.html | 84 +++++++++++++++++-- ...hantapi_products_v1.accounts.products.html | 42 +++++++++- ...roducts_v1beta.accounts.productInputs.html | 32 ++++--- ...api_products_v1beta.accounts.products.html | 16 ++-- .../documents/merchantapi.accounts_v1.json | 6 +- .../merchantapi.accounts_v1beta.json | 6 +- .../documents/merchantapi.products_v1.json | 68 ++++++++++++++- .../merchantapi.products_v1beta.json | 16 +++- 12 files changed, 253 insertions(+), 69 deletions(-) diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.html b/docs/dyn/merchantapi_accounts_v1.accounts.html index fcb3027a1d..ef843dc81f 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.html @@ -209,7 +209,7 @@ Method Details
The object takes the form of: { # Request message for the `CreateAndConfigureAccount` method. - "account": { # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. # Required. The account to be created. + "account": { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. # Required. The account to be created. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -268,7 +268,7 @@Method Details
Returns: An object of the form: - { # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -291,7 +291,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. +{ # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -312,7 +312,7 @@Method Details
Returns: An object of the form: - { # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -359,7 +359,7 @@Method Details
Returns: An object of the form: - { # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -391,7 +391,7 @@Method Details
{ # Response message for the `accounts.list` method. "accounts": [ # The accounts matching the `ListAccountsRequest`. - { # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -426,7 +426,7 @@Method Details
{ # Response message for the `ListSubAccounts` method. "accounts": [ # The accounts for which the given parent account is an aggregator. - { # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -480,7 +480,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. +{ # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -502,7 +502,7 @@Method Details
Returns: An object of the form: - { # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.programs.html b/docs/dyn/merchantapi_accounts_v1.accounts.programs.html index 0b06f6c7f8..d789cc0c6a 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.programs.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.programs.html @@ -123,7 +123,7 @@Method Details
Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-affiliate` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -162,7 +162,7 @@Method Details
Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-affiliate` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -195,7 +195,7 @@Method Details
Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-affiliate` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -233,7 +233,7 @@Method Details
{ # Response message for the ListPrograms method. "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "programs": [ # The programs for the given account. - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-affiliate` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.html index e68ea836ce..b053a1244c 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.html @@ -209,7 +209,7 @@Method Details
The object takes the form of: { # Request message for the `CreateAndConfigureAccount` method. - "account": { # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. # Required. The account to be created. + "account": { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. # Required. The account to be created. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -281,7 +281,7 @@Method Details
Returns: An object of the form: - { # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -304,7 +304,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. +{ # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -325,7 +325,7 @@Method Details
Returns: An object of the form: - { # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -372,7 +372,7 @@Method Details
Returns: An object of the form: - { # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -404,7 +404,7 @@Method Details
{ # Response message for the `accounts.list` method. "accounts": [ # The accounts matching the `ListAccountsRequest`. - { # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -439,7 +439,7 @@Method Details
{ # Response message for the `ListSubAccounts` method. "accounts": [ # The accounts for which the given parent account is an aggregator. - { # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -493,7 +493,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. +{ # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -515,7 +515,7 @@Method Details
Returns: An object of the form: - { # The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html index 280e094f79..7f03307d76 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html @@ -123,7 +123,7 @@Method Details
Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-affiliate` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -162,7 +162,7 @@Method Details
Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-affiliate` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -195,7 +195,7 @@Method Details
Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-affiliate` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -233,7 +233,7 @@Method Details
{ # Response message for the ListPrograms method. "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "programs": [ # The programs for the given account. - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-affiliate` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], diff --git a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html index 9903dcbacb..27f54c503b 100644 --- a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html +++ b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html @@ -243,7 +243,7 @@Method Details
], "gender": "A String", # Target [gender](https://support.google.com/merchants/answer/6324479) of the item. "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API. - "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. "A String", ], "handlingCutoffTimes": [ # The handling cutoff times for shipping. @@ -264,6 +264,7 @@Method Details
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, + "annualPercentageRate": 3.14, # Optional. Annual percentage rate for `credit_type` finance "creditType": "A String", # Type of installment payments. "downpayment": { # The price represented as a number and currency. # The up-front down payment amount the buyer has to pay. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). @@ -312,9 +313,20 @@Method Details
}, "minEnergyEfficiencyClass": "A String", # The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU. "minHandlingTime": "A String", # Minimal product handling time (in business days). + "minimumOrderValues": [ # The [minimum value](https://support.google.com/merchants/answer/16989009) in the cart before a customer can initiate checkout. Supports multiple minimum order values. Different minimum order values can be specified per country, service and surface. Maximum entries: 100. + { # The minimum order value in the cart before the checkout is permitted. + "country": "A String", # Required. The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship. + "price": { # The price represented as a number and currency. # Required. The minimum cart or basket value before the checkout is permitted. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "service": "A String", # A free-form description of the service class or delivery speed. This should match the service value set for the Shipping attribute. See service. + "surface": "A String", # The surface to which the minimum order value applies. Defaults to `ONLINE_LOCAL` if not configured. + }, + ], "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. "mobileLinkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices. - "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. + "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item. "multipack": "A String", # The number of identical products in a business-defined multipack. "pattern": "A String", # The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots. "pause": "A String", # Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930). @@ -373,6 +385,8 @@Method Details
"handlingCutoffTimezone": "A String", # [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example `Europe/Zurich`. This field only applies if `handling_cutoff_time` is set. If `handling_cutoff_time` is set but this field is not set, the shipping destination timezone will be used. If both fields are not set, the handling cutoff time will default to 8AM PST. "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name. "locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting). + "loyaltyProgramLabel": "A String", # Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. + "loyaltyTierLabel": "A String", # Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. "maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present. "maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present. "minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present. @@ -459,6 +473,9 @@Method Details
"unit": "A String", # The unit of the measure. "value": 3.14, # The measure of an item. }, + "videoLinks": [ # Optional. A list of video URLs for the item. Use this attribute to provide more visuals for your product beyond your image attributes. See the [Help Center article](https://support.google.com/merchants/answer/15216925) for more information. + "A String", + ], "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. }, "versionNumber": "A String", # Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources. If the operation is prevented, the aborted exception will be thrown. @@ -596,7 +613,7 @@Method Details
], "gender": "A String", # Target [gender](https://support.google.com/merchants/answer/6324479) of the item. "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API. - "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. "A String", ], "handlingCutoffTimes": [ # The handling cutoff times for shipping. @@ -617,6 +634,7 @@Method Details
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, + "annualPercentageRate": 3.14, # Optional. Annual percentage rate for `credit_type` finance "creditType": "A String", # Type of installment payments. "downpayment": { # The price represented as a number and currency. # The up-front down payment amount the buyer has to pay. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). @@ -665,9 +683,20 @@Method Details
}, "minEnergyEfficiencyClass": "A String", # The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU. "minHandlingTime": "A String", # Minimal product handling time (in business days). + "minimumOrderValues": [ # The [minimum value](https://support.google.com/merchants/answer/16989009) in the cart before a customer can initiate checkout. Supports multiple minimum order values. Different minimum order values can be specified per country, service and surface. Maximum entries: 100. + { # The minimum order value in the cart before the checkout is permitted. + "country": "A String", # Required. The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship. + "price": { # The price represented as a number and currency. # Required. The minimum cart or basket value before the checkout is permitted. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "service": "A String", # A free-form description of the service class or delivery speed. This should match the service value set for the Shipping attribute. See service. + "surface": "A String", # The surface to which the minimum order value applies. Defaults to `ONLINE_LOCAL` if not configured. + }, + ], "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. "mobileLinkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices. - "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. + "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item. "multipack": "A String", # The number of identical products in a business-defined multipack. "pattern": "A String", # The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots. "pause": "A String", # Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930). @@ -726,6 +755,8 @@Method Details
"handlingCutoffTimezone": "A String", # [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example `Europe/Zurich`. This field only applies if `handling_cutoff_time` is set. If `handling_cutoff_time` is set but this field is not set, the shipping destination timezone will be used. If both fields are not set, the handling cutoff time will default to 8AM PST. "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name. "locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting). + "loyaltyProgramLabel": "A String", # Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. + "loyaltyTierLabel": "A String", # Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. "maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present. "maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present. "minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present. @@ -812,6 +843,9 @@Method Details
"unit": "A String", # The unit of the measure. "value": 3.14, # The measure of an item. }, + "videoLinks": [ # Optional. A list of video URLs for the item. Use this attribute to provide more visuals for your product beyond your image attributes. See the [Help Center article](https://support.google.com/merchants/answer/15216925) for more information. + "A String", + ], "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. }, "versionNumber": "A String", # Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources. If the operation is prevented, the aborted exception will be thrown. @@ -950,7 +984,7 @@Method Details
], "gender": "A String", # Target [gender](https://support.google.com/merchants/answer/6324479) of the item. "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API. - "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. "A String", ], "handlingCutoffTimes": [ # The handling cutoff times for shipping. @@ -971,6 +1005,7 @@Method Details
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, + "annualPercentageRate": 3.14, # Optional. Annual percentage rate for `credit_type` finance "creditType": "A String", # Type of installment payments. "downpayment": { # The price represented as a number and currency. # The up-front down payment amount the buyer has to pay. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). @@ -1019,9 +1054,20 @@Method Details
}, "minEnergyEfficiencyClass": "A String", # The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU. "minHandlingTime": "A String", # Minimal product handling time (in business days). + "minimumOrderValues": [ # The [minimum value](https://support.google.com/merchants/answer/16989009) in the cart before a customer can initiate checkout. Supports multiple minimum order values. Different minimum order values can be specified per country, service and surface. Maximum entries: 100. + { # The minimum order value in the cart before the checkout is permitted. + "country": "A String", # Required. The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship. + "price": { # The price represented as a number and currency. # Required. The minimum cart or basket value before the checkout is permitted. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "service": "A String", # A free-form description of the service class or delivery speed. This should match the service value set for the Shipping attribute. See service. + "surface": "A String", # The surface to which the minimum order value applies. Defaults to `ONLINE_LOCAL` if not configured. + }, + ], "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. "mobileLinkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices. - "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. + "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item. "multipack": "A String", # The number of identical products in a business-defined multipack. "pattern": "A String", # The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots. "pause": "A String", # Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930). @@ -1080,6 +1126,8 @@Method Details
"handlingCutoffTimezone": "A String", # [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example `Europe/Zurich`. This field only applies if `handling_cutoff_time` is set. If `handling_cutoff_time` is set but this field is not set, the shipping destination timezone will be used. If both fields are not set, the handling cutoff time will default to 8AM PST. "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name. "locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting). + "loyaltyProgramLabel": "A String", # Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. + "loyaltyTierLabel": "A String", # Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. "maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present. "maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present. "minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present. @@ -1166,6 +1214,9 @@Method Details
"unit": "A String", # The unit of the measure. "value": 3.14, # The measure of an item. }, + "videoLinks": [ # Optional. A list of video URLs for the item. Use this attribute to provide more visuals for your product beyond your image attributes. See the [Help Center article](https://support.google.com/merchants/answer/15216925) for more information. + "A String", + ], "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. }, "versionNumber": "A String", # Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources. If the operation is prevented, the aborted exception will be thrown. @@ -1304,7 +1355,7 @@Method Details
], "gender": "A String", # Target [gender](https://support.google.com/merchants/answer/6324479) of the item. "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API. - "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. "A String", ], "handlingCutoffTimes": [ # The handling cutoff times for shipping. @@ -1325,6 +1376,7 @@Method Details
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, + "annualPercentageRate": 3.14, # Optional. Annual percentage rate for `credit_type` finance "creditType": "A String", # Type of installment payments. "downpayment": { # The price represented as a number and currency. # The up-front down payment amount the buyer has to pay. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). @@ -1373,9 +1425,20 @@Method Details
}, "minEnergyEfficiencyClass": "A String", # The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU. "minHandlingTime": "A String", # Minimal product handling time (in business days). + "minimumOrderValues": [ # The [minimum value](https://support.google.com/merchants/answer/16989009) in the cart before a customer can initiate checkout. Supports multiple minimum order values. Different minimum order values can be specified per country, service and surface. Maximum entries: 100. + { # The minimum order value in the cart before the checkout is permitted. + "country": "A String", # Required. The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship. + "price": { # The price represented as a number and currency. # Required. The minimum cart or basket value before the checkout is permitted. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "service": "A String", # A free-form description of the service class or delivery speed. This should match the service value set for the Shipping attribute. See service. + "surface": "A String", # The surface to which the minimum order value applies. Defaults to `ONLINE_LOCAL` if not configured. + }, + ], "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. "mobileLinkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices. - "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. + "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item. "multipack": "A String", # The number of identical products in a business-defined multipack. "pattern": "A String", # The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots. "pause": "A String", # Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930). @@ -1434,6 +1497,8 @@Method Details
"handlingCutoffTimezone": "A String", # [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example `Europe/Zurich`. This field only applies if `handling_cutoff_time` is set. If `handling_cutoff_time` is set but this field is not set, the shipping destination timezone will be used. If both fields are not set, the handling cutoff time will default to 8AM PST. "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name. "locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting). + "loyaltyProgramLabel": "A String", # Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. + "loyaltyTierLabel": "A String", # Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. "maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present. "maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present. "minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present. @@ -1520,6 +1585,9 @@Method Details
"unit": "A String", # The unit of the measure. "value": 3.14, # The measure of an item. }, + "videoLinks": [ # Optional. A list of video URLs for the item. Use this attribute to provide more visuals for your product beyond your image attributes. See the [Help Center article](https://support.google.com/merchants/answer/15216925) for more information. + "A String", + ], "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. }, "versionNumber": "A String", # Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources. If the operation is prevented, the aborted exception will be thrown. diff --git a/docs/dyn/merchantapi_products_v1.accounts.products.html b/docs/dyn/merchantapi_products_v1.accounts.products.html index 9507a81dbf..284938e671 100644 --- a/docs/dyn/merchantapi_products_v1.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1.accounts.products.html @@ -242,7 +242,7 @@Method Details
], "gender": "A String", # Target [gender](https://support.google.com/merchants/answer/6324479) of the item. "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API. - "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. "A String", ], "handlingCutoffTimes": [ # The handling cutoff times for shipping. @@ -263,6 +263,7 @@Method Details
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, + "annualPercentageRate": 3.14, # Optional. Annual percentage rate for `credit_type` finance "creditType": "A String", # Type of installment payments. "downpayment": { # The price represented as a number and currency. # The up-front down payment amount the buyer has to pay. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). @@ -311,9 +312,20 @@Method Details
}, "minEnergyEfficiencyClass": "A String", # The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU. "minHandlingTime": "A String", # Minimal product handling time (in business days). + "minimumOrderValues": [ # The [minimum value](https://support.google.com/merchants/answer/16989009) in the cart before a customer can initiate checkout. Supports multiple minimum order values. Different minimum order values can be specified per country, service and surface. Maximum entries: 100. + { # The minimum order value in the cart before the checkout is permitted. + "country": "A String", # Required. The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship. + "price": { # The price represented as a number and currency. # Required. The minimum cart or basket value before the checkout is permitted. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "service": "A String", # A free-form description of the service class or delivery speed. This should match the service value set for the Shipping attribute. See service. + "surface": "A String", # The surface to which the minimum order value applies. Defaults to `ONLINE_LOCAL` if not configured. + }, + ], "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. "mobileLinkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices. - "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. + "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item. "multipack": "A String", # The number of identical products in a business-defined multipack. "pattern": "A String", # The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots. "pause": "A String", # Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930). @@ -372,6 +384,8 @@Method Details
"handlingCutoffTimezone": "A String", # [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example `Europe/Zurich`. This field only applies if `handling_cutoff_time` is set. If `handling_cutoff_time` is set but this field is not set, the shipping destination timezone will be used. If both fields are not set, the handling cutoff time will default to 8AM PST. "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name. "locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting). + "loyaltyProgramLabel": "A String", # Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. + "loyaltyTierLabel": "A String", # Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. "maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present. "maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present. "minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present. @@ -458,6 +472,9 @@Method Details
"unit": "A String", # The unit of the measure. "value": 3.14, # The measure of an item. }, + "videoLinks": [ # Optional. A list of video URLs for the item. Use this attribute to provide more visuals for your product beyond your image attributes. See the [Help Center article](https://support.google.com/merchants/answer/15216925) for more information. + "A String", + ], "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. }, "productStatus": { # The status of a product, data validation issues, that is, information about a product computed asynchronously. # Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously. @@ -653,7 +670,7 @@Method Details
], "gender": "A String", # Target [gender](https://support.google.com/merchants/answer/6324479) of the item. "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API. - "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. "A String", ], "handlingCutoffTimes": [ # The handling cutoff times for shipping. @@ -674,6 +691,7 @@Method Details
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, + "annualPercentageRate": 3.14, # Optional. Annual percentage rate for `credit_type` finance "creditType": "A String", # Type of installment payments. "downpayment": { # The price represented as a number and currency. # The up-front down payment amount the buyer has to pay. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). @@ -722,9 +740,20 @@Method Details
}, "minEnergyEfficiencyClass": "A String", # The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU. "minHandlingTime": "A String", # Minimal product handling time (in business days). + "minimumOrderValues": [ # The [minimum value](https://support.google.com/merchants/answer/16989009) in the cart before a customer can initiate checkout. Supports multiple minimum order values. Different minimum order values can be specified per country, service and surface. Maximum entries: 100. + { # The minimum order value in the cart before the checkout is permitted. + "country": "A String", # Required. The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship. + "price": { # The price represented as a number and currency. # Required. The minimum cart or basket value before the checkout is permitted. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "service": "A String", # A free-form description of the service class or delivery speed. This should match the service value set for the Shipping attribute. See service. + "surface": "A String", # The surface to which the minimum order value applies. Defaults to `ONLINE_LOCAL` if not configured. + }, + ], "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. "mobileLinkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices. - "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. + "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item. "multipack": "A String", # The number of identical products in a business-defined multipack. "pattern": "A String", # The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots. "pause": "A String", # Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930). @@ -783,6 +812,8 @@Method Details
"handlingCutoffTimezone": "A String", # [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example `Europe/Zurich`. This field only applies if `handling_cutoff_time` is set. If `handling_cutoff_time` is set but this field is not set, the shipping destination timezone will be used. If both fields are not set, the handling cutoff time will default to 8AM PST. "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name. "locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting). + "loyaltyProgramLabel": "A String", # Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. + "loyaltyTierLabel": "A String", # Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. "maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present. "maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present. "minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present. @@ -869,6 +900,9 @@Method Details
"unit": "A String", # The unit of the measure. "value": 3.14, # The measure of an item. }, + "videoLinks": [ # Optional. A list of video URLs for the item. Use this attribute to provide more visuals for your product beyond your image attributes. See the [Help Center article](https://support.google.com/merchants/answer/15216925) for more information. + "A String", + ], "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. }, "productStatus": { # The status of a product, data validation issues, that is, information about a product computed asynchronously. # Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously. diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html index 223a8ad2b0..ebad4bcea1 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html @@ -203,10 +203,10 @@Method Details
], "gender": "A String", # Target [gender](https://support.google.com/merchants/answer/6324479) of the item. For example, "male" or "female". "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API. - "gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. + "gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. "A String", ], - "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. "A String", ], "identifierExists": True or False, # Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided. @@ -269,7 +269,7 @@Method Details
"minHandlingTime": "A String", # Minimal product handling time (in business days). "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. "mobileLinkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices. - "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. + "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item. "multipack": "A String", # The number of identical products in a business-defined multipack. "pattern": "A String", # The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots. "pause": "A String", # Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930). @@ -327,6 +327,8 @@Method Details
"handlingCutoffTimezone": "A String", # [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example `Europe/Zurich`. This field only applies if `handling_cutoff_time` is set. If `handling_cutoff_time` is set but this field is not set, the shipping destination timezone will be used. If both fields are not set, the handling cutoff time will default to 8AM PST. "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name. "locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting). + "loyaltyProgramLabel": "A String", # Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. + "loyaltyTierLabel": "A String", # Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. "maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present. "maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present. "minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present. @@ -526,10 +528,10 @@Method Details
], "gender": "A String", # Target [gender](https://support.google.com/merchants/answer/6324479) of the item. For example, "male" or "female". "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API. - "gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. + "gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. "A String", ], - "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. "A String", ], "identifierExists": True or False, # Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided. @@ -592,7 +594,7 @@Method Details
"minHandlingTime": "A String", # Minimal product handling time (in business days). "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. "mobileLinkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices. - "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. + "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item. "multipack": "A String", # The number of identical products in a business-defined multipack. "pattern": "A String", # The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots. "pause": "A String", # Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930). @@ -650,6 +652,8 @@Method Details
"handlingCutoffTimezone": "A String", # [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example `Europe/Zurich`. This field only applies if `handling_cutoff_time` is set. If `handling_cutoff_time` is set but this field is not set, the shipping destination timezone will be used. If both fields are not set, the handling cutoff time will default to 8AM PST. "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name. "locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting). + "loyaltyProgramLabel": "A String", # Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. + "loyaltyTierLabel": "A String", # Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. "maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present. "maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present. "minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present. @@ -850,10 +854,10 @@Method Details
], "gender": "A String", # Target [gender](https://support.google.com/merchants/answer/6324479) of the item. For example, "male" or "female". "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API. - "gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. + "gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. "A String", ], - "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. "A String", ], "identifierExists": True or False, # Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided. @@ -916,7 +920,7 @@Method Details
"minHandlingTime": "A String", # Minimal product handling time (in business days). "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. "mobileLinkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices. - "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. + "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item. "multipack": "A String", # The number of identical products in a business-defined multipack. "pattern": "A String", # The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots. "pause": "A String", # Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930). @@ -974,6 +978,8 @@Method Details
"handlingCutoffTimezone": "A String", # [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example `Europe/Zurich`. This field only applies if `handling_cutoff_time` is set. If `handling_cutoff_time` is set but this field is not set, the shipping destination timezone will be used. If both fields are not set, the handling cutoff time will default to 8AM PST. "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name. "locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting). + "loyaltyProgramLabel": "A String", # Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. + "loyaltyTierLabel": "A String", # Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. "maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present. "maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present. "minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present. @@ -1174,10 +1180,10 @@Method Details
], "gender": "A String", # Target [gender](https://support.google.com/merchants/answer/6324479) of the item. For example, "male" or "female". "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API. - "gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. + "gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. "A String", ], - "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. "A String", ], "identifierExists": True or False, # Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided. @@ -1240,7 +1246,7 @@Method Details
"minHandlingTime": "A String", # Minimal product handling time (in business days). "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. "mobileLinkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices. - "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. + "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item. "multipack": "A String", # The number of identical products in a business-defined multipack. "pattern": "A String", # The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots. "pause": "A String", # Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930). @@ -1298,6 +1304,8 @@Method Details
"handlingCutoffTimezone": "A String", # [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example `Europe/Zurich`. This field only applies if `handling_cutoff_time` is set. If `handling_cutoff_time` is set but this field is not set, the shipping destination timezone will be used. If both fields are not set, the handling cutoff time will default to 8AM PST. "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name. "locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting). + "loyaltyProgramLabel": "A String", # Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. + "loyaltyTierLabel": "A String", # Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. "maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present. "maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present. "minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present. diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.products.html b/docs/dyn/merchantapi_products_v1beta.accounts.products.html index a5df9a4740..38132dba38 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.products.html @@ -189,10 +189,10 @@Method Details
], "gender": "A String", # Target [gender](https://support.google.com/merchants/answer/6324479) of the item. For example, "male" or "female". "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API. - "gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. + "gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. "A String", ], - "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. "A String", ], "identifierExists": True or False, # Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided. @@ -255,7 +255,7 @@Method Details
"minHandlingTime": "A String", # Minimal product handling time (in business days). "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. "mobileLinkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices. - "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. + "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item. "multipack": "A String", # The number of identical products in a business-defined multipack. "pattern": "A String", # The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots. "pause": "A String", # Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930). @@ -313,6 +313,8 @@Method Details
"handlingCutoffTimezone": "A String", # [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example `Europe/Zurich`. This field only applies if `handling_cutoff_time` is set. If `handling_cutoff_time` is set but this field is not set, the shipping destination timezone will be used. If both fields are not set, the handling cutoff time will default to 8AM PST. "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name. "locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting). + "loyaltyProgramLabel": "A String", # Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. + "loyaltyTierLabel": "A String", # Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. "maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present. "maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present. "minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present. @@ -570,10 +572,10 @@Method Details
], "gender": "A String", # Target [gender](https://support.google.com/merchants/answer/6324479) of the item. For example, "male" or "female". "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API. - "gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. + "gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. "A String", ], - "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. "A String", ], "identifierExists": True or False, # Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided. @@ -636,7 +638,7 @@Method Details
"minHandlingTime": "A String", # Minimal product handling time (in business days). "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. "mobileLinkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices. - "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. + "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item. "multipack": "A String", # The number of identical products in a business-defined multipack. "pattern": "A String", # The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots. "pause": "A String", # Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930). @@ -694,6 +696,8 @@Method Details
"handlingCutoffTimezone": "A String", # [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example `Europe/Zurich`. This field only applies if `handling_cutoff_time` is set. If `handling_cutoff_time` is set but this field is not set, the shipping destination timezone will be used. If both fields are not set, the handling cutoff time will default to 8AM PST. "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name. "locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting). + "loyaltyProgramLabel": "A String", # Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. + "loyaltyTierLabel": "A String", # Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier. "maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present. "maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present. "minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present. diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json index 112fa89a8f..1c757d55e6 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json @@ -2438,7 +2438,7 @@ } } }, -"revision": "20260411", +"revision": "20260415", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -2502,7 +2502,7 @@ "type": "object" }, "Account": { -"description": "The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on.", +"description": "The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on.", "id": "Account", "properties": { "accountId": { @@ -4907,7 +4907,7 @@ false "type": "object" }, "Program": { -"description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-shopping-checkout`", +"description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-affiliate` * `youtube-shopping-checkout`", "id": "Program", "properties": { "activeRegionCodes": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index 7ef40a9499..6b4ff35ffe 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -2388,7 +2388,7 @@ } } }, -"revision": "20260411", +"revision": "20260415", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -2452,7 +2452,7 @@ "type": "object" }, "Account": { -"description": "The `Account` message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on.", +"description": "The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on.", "id": "Account", "properties": { "accountId": { @@ -4784,7 +4784,7 @@ false "type": "object" }, "Program": { -"description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-shopping-checkout`", +"description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `youtube-affiliate` * `youtube-shopping-checkout`", "id": "Program", "properties": { "activeRegionCodes": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json index 1b04f4e9ba..7f8790f04f 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json @@ -281,7 +281,7 @@ } } }, -"revision": "20260408", +"revision": "20260419", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AutomatedDiscounts": { @@ -1386,7 +1386,7 @@ false "type": "string" }, "gtins": { -"description": "Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs.", +"description": "Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs.", "items": { "type": "string" }, @@ -1560,6 +1560,13 @@ false "format": "int64", "type": "string" }, +"minimumOrderValues": { +"description": "The [minimum value](https://support.google.com/merchants/answer/16989009) in the cart before a customer can initiate checkout. Supports multiple minimum order values. Different minimum order values can be specified per country, service and surface. Maximum entries: 100.", +"items": { +"$ref": "ProductMinimumOrderValue" +}, +"type": "array" +}, "mobileLink": { "description": "URL for the mobile-optimized version of your item's landing page.", "type": "string" @@ -1569,7 +1576,7 @@ false "type": "string" }, "mpn": { -"description": "Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.", +"description": "Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item.", "type": "string" }, "multipack": { @@ -1848,6 +1855,13 @@ false "$ref": "UnitPricingMeasure", "description": "The measure and dimension of an item." }, +"videoLinks": { +"description": "Optional. A list of video URLs for the item. Use this attribute to provide more visuals for your product beyond your image attributes. See the [Help Center article](https://support.google.com/merchants/answer/15216925) for more information.", +"items": { +"type": "string" +}, +"type": "array" +}, "virtualModelLink": { "description": "URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information.", "type": "string" @@ -2100,6 +2114,11 @@ false "$ref": "Price", "description": "The amount the buyer has to pay per month." }, +"annualPercentageRate": { +"description": "Optional. Annual percentage rate for `credit_type` finance", +"format": "double", +"type": "number" +}, "creditType": { "description": "Type of installment payments.", "enum": [ @@ -2126,6 +2145,41 @@ false }, "type": "object" }, +"ProductMinimumOrderValue": { +"description": "The minimum order value in the cart before the checkout is permitted.", +"id": "ProductMinimumOrderValue", +"properties": { +"country": { +"description": "Required. The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship.", +"type": "string" +}, +"price": { +"$ref": "Price", +"description": "Required. The minimum cart or basket value before the checkout is permitted." +}, +"service": { +"description": "A free-form description of the service class or delivery speed. This should match the service value set for the Shipping attribute. See service.", +"type": "string" +}, +"surface": { +"description": "The surface to which the minimum order value applies. Defaults to `ONLINE_LOCAL` if not configured.", +"enum": [ +"SURFACE_UNSPECIFIED", +"ONLINE", +"LOCAL", +"ONLINE_LOCAL" +], +"enumDescriptions": [ +"Surface is unspecified.", +"Surface value to indicate online purchases.", +"Surface value to indicate local purchases.", +"Surface value to indicate online and local purchases." +], +"type": "string" +} +}, +"type": "object" +}, "ProductStatus": { "description": "The status of a product, data validation issues, that is, information about a product computed asynchronously.", "id": "ProductStatus", @@ -2297,6 +2351,14 @@ false "format": "int64", "type": "string" }, +"loyaltyProgramLabel": { +"description": "Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier.", +"type": "string" +}, +"loyaltyTierLabel": { +"description": "Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier.", +"type": "string" +}, "maxHandlingTime": { "description": "Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present.", "format": "int64", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json index da6584df83..7832987f82 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json @@ -281,7 +281,7 @@ } } }, -"revision": "20260408", +"revision": "20260419", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -455,14 +455,14 @@ }, "gtin": { "deprecated": true, -"description": "Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead.", +"description": "Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead.", "items": { "type": "string" }, "type": "array" }, "gtins": { -"description": "A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs.", +"description": "A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs.", "items": { "type": "string" }, @@ -556,7 +556,7 @@ "type": "string" }, "mpn": { -"description": "Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.", +"description": "Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item.", "type": "string" }, "multipack": { @@ -1709,6 +1709,14 @@ false "format": "int64", "type": "string" }, +"loyaltyProgramLabel": { +"description": "Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier.", +"type": "string" +}, +"loyaltyTierLabel": { +"description": "Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier.", +"type": "string" +}, "maxHandlingTime": { "description": "Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present.", "format": "int64", From 64c233d9028d170accfe3b526a7b80bb7cfad925 Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 21 Apr 2026 07:41:56 +0000 Subject: [PATCH 14/18] feat(networkmanagement): update the api #### networkmanagement:v1beta1 The following keys were added: - schemas.Endpoint.properties.datastreamPrivateConnection.type (Total Keys: 1) - schemas.Endpoint.properties.dmsPrivateConnection.type (Total Keys: 1) --- ...management_v1.organizations.locations.html | 4 +-- ...s.locations.global_.connectivityTests.html | 16 +++++----- ...tworkmanagement_v1.projects.locations.html | 4 +-- ...ement_v1beta1.organizations.locations.html | 4 +-- ...s.locations.global_.connectivityTests.html | 32 ++++++++++++++----- ...management_v1beta1.projects.locations.html | 4 +-- .../documents/networkmanagement.v1.json | 8 ++--- .../documents/networkmanagement.v1beta1.json | 16 +++++++--- 8 files changed, 56 insertions(+), 32 deletions(-) diff --git a/docs/dyn/networkmanagement_v1.organizations.locations.html b/docs/dyn/networkmanagement_v1.organizations.locations.html index a1f0040e47..a69a2ad118 100644 --- a/docs/dyn/networkmanagement_v1.organizations.locations.html +++ b/docs/dyn/networkmanagement_v1.organizations.locations.html @@ -92,7 +92,7 @@ Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -131,7 +131,7 @@Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html index eef3c069d5..0c71643dd4 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html @@ -520,7 +520,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. @@ -875,7 +875,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. @@ -1433,7 +1433,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. @@ -1788,7 +1788,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. @@ -2337,7 +2337,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. @@ -2692,7 +2692,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. @@ -3200,7 +3200,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. @@ -3555,7 +3555,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. diff --git a/docs/dyn/networkmanagement_v1.projects.locations.html b/docs/dyn/networkmanagement_v1.projects.locations.html index d9c73c2af0..0f4db31146 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.html @@ -92,7 +92,7 @@Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -131,7 +131,7 @@Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/networkmanagement_v1beta1.organizations.locations.html b/docs/dyn/networkmanagement_v1beta1.organizations.locations.html index 80d6442eb2..030f903858 100644 --- a/docs/dyn/networkmanagement_v1beta1.organizations.locations.html +++ b/docs/dyn/networkmanagement_v1beta1.organizations.locations.html @@ -92,7 +92,7 @@Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -131,7 +131,7 @@Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html index 56b1bcdd3d..ba7b109038 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -138,6 +138,8 @@Method Details
"uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. + "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. "forwardingRule": "A String", # A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Applicable only to destination endpoint. Format: `projects/{project}/global/forwardingRules/{id}` or `projects/{project}/regions/{region}/forwardingRules/{id}` "forwardingRuleTarget": "A String", # Output only. Specifies the type of the target of the forwarding rule. "fqdn": "A String", # DNS endpoint of [Google Kubernetes Engine cluster control plane](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). Requires gke_master_cluster to be set, can't be used simultaneoulsly with ip_address or network. Applicable only to destination endpoint. @@ -520,7 +522,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. @@ -875,7 +877,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. @@ -937,6 +939,8 @@Method Details
"uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. + "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. "forwardingRule": "A String", # A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Applicable only to destination endpoint. Format: `projects/{project}/global/forwardingRules/{id}` or `projects/{project}/regions/{region}/forwardingRules/{id}` "forwardingRuleTarget": "A String", # Output only. Specifies the type of the target of the forwarding rule. "fqdn": "A String", # DNS endpoint of [Google Kubernetes Engine cluster control plane](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). Requires gke_master_cluster to be set, can't be used simultaneoulsly with ip_address or network. Applicable only to destination endpoint. @@ -1051,6 +1055,8 @@Method Details
"uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. + "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. "forwardingRule": "A String", # A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Applicable only to destination endpoint. Format: `projects/{project}/global/forwardingRules/{id}` or `projects/{project}/regions/{region}/forwardingRules/{id}` "forwardingRuleTarget": "A String", # Output only. Specifies the type of the target of the forwarding rule. "fqdn": "A String", # DNS endpoint of [Google Kubernetes Engine cluster control plane](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). Requires gke_master_cluster to be set, can't be used simultaneoulsly with ip_address or network. Applicable only to destination endpoint. @@ -1433,7 +1439,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. @@ -1788,7 +1794,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. @@ -1850,6 +1856,8 @@Method Details
"uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. + "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. "forwardingRule": "A String", # A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Applicable only to destination endpoint. Format: `projects/{project}/global/forwardingRules/{id}` or `projects/{project}/regions/{region}/forwardingRules/{id}` "forwardingRuleTarget": "A String", # Output only. Specifies the type of the target of the forwarding rule. "fqdn": "A String", # DNS endpoint of [Google Kubernetes Engine cluster control plane](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). Requires gke_master_cluster to be set, can't be used simultaneoulsly with ip_address or network. Applicable only to destination endpoint. @@ -1955,6 +1963,8 @@Method Details
"uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. + "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. "forwardingRule": "A String", # A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Applicable only to destination endpoint. Format: `projects/{project}/global/forwardingRules/{id}` or `projects/{project}/regions/{region}/forwardingRules/{id}` "forwardingRuleTarget": "A String", # Output only. Specifies the type of the target of the forwarding rule. "fqdn": "A String", # DNS endpoint of [Google Kubernetes Engine cluster control plane](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). Requires gke_master_cluster to be set, can't be used simultaneoulsly with ip_address or network. Applicable only to destination endpoint. @@ -2337,7 +2347,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. @@ -2692,7 +2702,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. @@ -2754,6 +2764,8 @@Method Details
"uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. + "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. "forwardingRule": "A String", # A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Applicable only to destination endpoint. Format: `projects/{project}/global/forwardingRules/{id}` or `projects/{project}/regions/{region}/forwardingRules/{id}` "forwardingRuleTarget": "A String", # Output only. Specifies the type of the target of the forwarding rule. "fqdn": "A String", # DNS endpoint of [Google Kubernetes Engine cluster control plane](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). Requires gke_master_cluster to be set, can't be used simultaneoulsly with ip_address or network. Applicable only to destination endpoint. @@ -2818,6 +2830,8 @@Method Details
"uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. + "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. "forwardingRule": "A String", # A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Applicable only to destination endpoint. Format: `projects/{project}/global/forwardingRules/{id}` or `projects/{project}/regions/{region}/forwardingRules/{id}` "forwardingRuleTarget": "A String", # Output only. Specifies the type of the target of the forwarding rule. "fqdn": "A String", # DNS endpoint of [Google Kubernetes Engine cluster control plane](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). Requires gke_master_cluster to be set, can't be used simultaneoulsly with ip_address or network. Applicable only to destination endpoint. @@ -3200,7 +3214,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. @@ -3555,7 +3569,7 @@Method Details
"protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", ], - "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. + "region": "A String", # Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. "routeScope": "A String", # Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. "routeType": "A String", # Type of route. "srcIpRange": "A String", # Source IP address range of the route. POLICY_BASED routes only. @@ -3617,6 +3631,8 @@Method Details
"uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. + "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. "forwardingRule": "A String", # A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Applicable only to destination endpoint. Format: `projects/{project}/global/forwardingRules/{id}` or `projects/{project}/regions/{region}/forwardingRules/{id}` "forwardingRuleTarget": "A String", # Output only. Specifies the type of the target of the forwarding rule. "fqdn": "A String", # DNS endpoint of [Google Kubernetes Engine cluster control plane](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). Requires gke_master_cluster to be set, can't be used simultaneoulsly with ip_address or network. Applicable only to destination endpoint. diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.html index 02bc3d3b0c..78a797d00a 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.html @@ -92,7 +92,7 @@Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -131,7 +131,7 @@Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index 7ff2185a6e..5bcc2809e4 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/organizations/{organizationsId}/locations", "httpMethod": "GET", "id": "networkmanagement.organizations.locations.list", @@ -516,7 +516,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "networkmanagement.projects.locations.list", @@ -1237,7 +1237,7 @@ } } }, -"revision": "20260327", +"revision": "20260414", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -3883,7 +3883,7 @@ false "type": "array" }, "region": { -"description": "Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to.", +"description": "Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to \"all\" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions.", "type": "string" }, "routeScope": { diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index 895a734e85..98e3ac3209 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta1/organizations/{organizationsId}/locations", "httpMethod": "GET", "id": "networkmanagement.organizations.locations.list", @@ -516,7 +516,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "networkmanagement.projects.locations.list", @@ -1237,7 +1237,7 @@ } } }, -"revision": "20260327", +"revision": "20260414", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -2233,6 +2233,14 @@ false "description": "A [Cloud SQL](https://cloud.google.com/sql) instance URI.", "type": "string" }, +"datastreamPrivateConnection": { +"description": "A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}.", +"type": "string" +}, +"dmsPrivateConnection": { +"description": "A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}.", +"type": "string" +}, "forwardingRule": { "description": "A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Applicable only to destination endpoint. Format: `projects/{project}/global/forwardingRules/{id}` or `projects/{project}/regions/{region}/forwardingRules/{id}`", "type": "string" @@ -3883,7 +3891,7 @@ false "type": "array" }, "region": { -"description": "Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to.", +"description": "Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to \"all\" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions.", "type": "string" }, "routeScope": { From 81e02cc330bb33c17d1d3ca6a48c65cb85f2aaa6 Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 21 Apr 2026 07:41:56 +0000 Subject: [PATCH 15/18] fix(observability): update the api #### observability:v1 The following keys were changed: - endpoints (Total Keys: 1) --- .../documents/observability.v1.json | 132 +++++++++++++++++- 1 file changed, 131 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/observability.v1.json b/googleapiclient/discovery_cache/documents/observability.v1.json index 3fea22b8a4..7ee1d79116 100644 --- a/googleapiclient/discovery_cache/documents/observability.v1.json +++ b/googleapiclient/discovery_cache/documents/observability.v1.json @@ -18,11 +18,141 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://observability.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.asia-southeast3.rep.googleapis.com/", +"location": "asia-southeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://observability.us-central1.rep.googleapis.com/", "location": "us-central1" }, { "description": "Regional Endpoint", +"endpointUrl": "https://observability.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://observability.us.rep.googleapis.com/", "location": "us" }, @@ -1516,7 +1646,7 @@ } } }, -"revision": "20260319", +"revision": "20260409", "rootUrl": "https://observability.googleapis.com/", "schemas": { "Bucket": { From a5f1ffc867ca784ecae672b3b98a69a3b7a59d2f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 21 Apr 2026 07:41:56 +0000 Subject: [PATCH 16/18] feat(searchads360): update the api #### searchads360:v0 The following keys were added: - schemas.GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraint (Total Keys: 9) - schemas.GoogleAdsSearchads360V23Common_PolicyTopicConstraint_ResellerConstraint (Total Keys: 2) - schemas.GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationMismatch (Total Keys: 2) - schemas.GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationNotWorking (Total Keys: 7) - schemas.GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationTextList (Total Keys: 4) - schemas.GoogleAdsSearchads360V23Common_PolicyTopicEvidence_TextList (Total Keys: 4) - schemas.GoogleAdsSearchads360V23Common_PolicyTopicEvidence_WebsiteList (Total Keys: 4) - schemas.GoogleAdsSearchads360V23Common__PolicyTopicConstraint (Total Keys: 6) - schemas.GoogleAdsSearchads360V23Common__PolicyTopicEntry (Total Keys: 8) - schemas.GoogleAdsSearchads360V23Common__PolicyTopicEvidence (Total Keys: 8) - schemas.GoogleAdsSearchads360V23Common__PolicyViolationKey (Total Keys: 4) - schemas.GoogleAdsSearchads360V23Common__Value (Total Keys: 10) - schemas.GoogleAdsSearchads360V23Errors_ErrorLocation_FieldPathElement (Total Keys: 5) - schemas.GoogleAdsSearchads360V23Errors__BudgetPerDayMinimumErrorDetails (Total Keys: 13) - schemas.GoogleAdsSearchads360V23Errors__ErrorCode (Total Keys: 166) - schemas.GoogleAdsSearchads360V23Errors__ErrorDetails (Total Keys: 8) - schemas.GoogleAdsSearchads360V23Errors__ErrorLocation (Total Keys: 4) - schemas.GoogleAdsSearchads360V23Errors__PolicyFindingDetails (Total Keys: 4) - schemas.GoogleAdsSearchads360V23Errors__PolicyViolationDetails (Total Keys: 5) - schemas.GoogleAdsSearchads360V23Errors__QuotaErrorDetails (Total Keys: 6) - schemas.GoogleAdsSearchads360V23Errors__ResourceCountDetails (Total Keys: 9) - schemas.GoogleAdsSearchads360V23Errors__SearchAds360Error (Total Keys: 7) - schemas.GoogleAdsSearchads360V23Errors__SearchAds360Failure (Total Keys: 5) - schemas.GoogleAdsSearchads360V23Resources_BatchJob_BatchJobMetadata (Total Keys: 19) - schemas.GoogleAdsSearchads360V23Resources__OfflineUserDataJobMetadata (Total Keys: 4) - schemas.GoogleAdsSearchads360V23Services__PromoteExperimentMetadata (Total Keys: 3) - schemas.GoogleAdsSearchads360V23Services__ScheduleExperimentMetadata (Total Keys: 3) --- ...earchads360_v0.customers.searchAds360.html | 4 +- .../documents/searchads360.v0.json | 7276 ++++++++++++++++- 2 files changed, 7248 insertions(+), 32 deletions(-) diff --git a/docs/dyn/searchads360_v0.customers.searchAds360.html b/docs/dyn/searchads360_v0.customers.searchAds360.html index cf43f2c61a..288d199614 100644 --- a/docs/dyn/searchads360_v0.customers.searchAds360.html +++ b/docs/dyn/searchads360_v0.customers.searchAds360.html @@ -79,7 +79,7 @@ Instance Methods
Close httplib2 connections.
-
search(customerId, body=None, x__xgafv=None)Returns all rows that match the search query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
+Returns all rows that match the search query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ChangeEventError]() [ChangeStatusError]() [ClickViewError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
Retrieves the next page of results.
@@ -91,7 +91,7 @@Method Details
search(customerId, body=None, x__xgafv=None)-Returns all rows that match the search query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]() +Returns all rows that match the search query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ChangeEventError]() [ChangeStatusError]() [ClickViewError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]() Args: customerId: string, Required. The ID of the customer being queried. (required) diff --git a/googleapiclient/discovery_cache/documents/searchads360.v0.json b/googleapiclient/discovery_cache/documents/searchads360.v0.json index acc717e78c..300318b168 100644 --- a/googleapiclient/discovery_cache/documents/searchads360.v0.json +++ b/googleapiclient/discovery_cache/documents/searchads360.v0.json @@ -181,7 +181,7 @@ "searchAds360": { "methods": { "search": { -"description": "Returns all rows that match the search query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()", +"description": "Returns all rows that match the search query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ChangeEventError]() [ChangeStatusError]() [ClickViewError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()", "flatPath": "v0/customers/{customersId}/searchAds360:search", "httpMethod": "POST", "id": "searchads360.customers.searchAds360.search", @@ -260,7 +260,7 @@ } } }, -"revision": "20260307", +"revision": "20260413", "rootUrl": "https://searchads360.googleapis.com/", "schemas": { "GoogleAdsSearchads360V0Common__AdScheduleInfo": { @@ -449,12 +449,6 @@ "LEAD_FORM", "BUSINESS_LOGO", "DESCRIPTION_PREFIX", -"APP_ICON", -"APP_TITLE", -"APP_SCREENSHOT", -"APP_COVER_PHOTO", -"APP_SHORT_DESCRIPTION", -"APP_DEVELOPER_NAME", "HEADLINE_AS_SITELINK_POSITION_ONE", "HEADLINE_AS_SITELINK_POSITION_TWO", "DESCRIPTION_LINE_HEADLINE_AS_SITELINK_POSITION_ONE", @@ -494,12 +488,6 @@ "The asset is used as a lead form.", "The asset is used as a business logo.", "The asset is used as a description prefix.", -"The asset is used as an app icon.", -"The asset is used as an app title.", -"The asset is used as an app screenshot.", -"The asset is used as an app cover photo.", -"The asset is used as an app short description.", -"The asset is used as an app developer name.", "A headline asset used as a sitelink in position 1.", "A headline asset used as a sitelink in position 2.", "A description line asset used as a sitelink in position 1.", @@ -1812,8 +1800,7 @@ "STORE_VISIT", "STORE_SALE", "QUALIFIED_LEAD", -"CONVERTED_LEAD", -"YOUTUBE_FOLLOW_ON_VIEWS" +"CONVERTED_LEAD" ], "enumDescriptions": [ "Not specified.", @@ -1839,8 +1826,7 @@ "A visit to a physical store location.", "A sale occurring in a physical store.", "A lead conversion imported from an external source into Google Ads, that has been further qualified by the advertiser (marketing/sales team). In the lead-to-sale journey, advertisers get leads, then act on them by reaching out to the consumer. If the consumer is interested and may end up buying their product, the advertiser marks such leads as \"qualified leads\".", -"A lead conversion imported from an external source into Google Ads, that has further completed a chosen stage as defined by the lead gen advertiser.", -"User watches an ad from a channel and later watches either the same video or a video from the same channel as the ad." +"A lead conversion imported from an external source into Google Ads, that has further completed a chosen stage as defined by the lead gen advertiser." ], "type": "string" }, @@ -4198,10 +4184,7 @@ "VIDEO_RESPONSIVE_AD", "SMART_CAMPAIGN_AD", "APP_PRE_REGISTRATION_AD", -"DISCOVERY_MULTI_ASSET_AD", -"DISCOVERY_CAROUSEL_AD", "TRAVEL_AD", -"DISCOVERY_VIDEO_RESPONSIVE_AD", "MULTIMEDIA_AD" ], "enumDescriptions": [ @@ -4235,10 +4218,7 @@ "Video responsive ad.", "Smart campaign ad.", "Universal app pre-registration ad.", -"Discovery multi asset ad.", -"Discovery carousel ad.", "Travel ad.", -"Discovery video responsive ad.", "Multimedia ad." ], "readOnly": true, @@ -4414,7 +4394,6 @@ false "SEARCH_STANDARD", "DISPLAY_STANDARD", "SHOPPING_PRODUCT_ADS", -"SHOPPING_SHOWCASE_ADS", "HOTEL_ADS", "SHOPPING_SMART_ADS", "VIDEO_BUMPER", @@ -4436,7 +4415,6 @@ false "The default ad group type for Search campaigns.", "The default ad group type for Display campaigns.", "The ad group type for Shopping campaigns serving standard product ads.", -"The type for ad groups that are limited to serving Showcase or Merchant ads in Shopping results.", "The default ad group type for Hotel campaigns.", "The type for ad groups in Smart Shopping campaigns.", "Short unskippable in-stream video ads.", @@ -7151,8 +7129,7 @@ false "STORE_VISIT", "STORE_SALE", "QUALIFIED_LEAD", -"CONVERTED_LEAD", -"YOUTUBE_FOLLOW_ON_VIEWS" +"CONVERTED_LEAD" ], "enumDescriptions": [ "Not specified.", @@ -7178,8 +7155,7 @@ false "A visit to a physical store location.", "A sale occurring in a physical store.", "A lead conversion imported from an external source into Google Ads, that has been further qualified by the advertiser (marketing/sales team). In the lead-to-sale journey, advertisers get leads, then act on them by reaching out to the consumer. If the consumer is interested and may end up buying their product, the advertiser marks such leads as \"qualified leads\".", -"A lead conversion imported from an external source into Google Ads, that has further completed a chosen stage as defined by the lead gen advertiser.", -"User watches an ad from a channel and later watches either the same video or a video from the same channel as the ad." +"A lead conversion imported from an external source into Google Ads, that has further completed a chosen stage as defined by the lead gen advertiser." ], "type": "string" }, @@ -9320,6 +9296,7246 @@ false } }, "type": "object" +}, +"GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraint": { +"description": "Indicates that a resource's ability to serve in a particular country is constrained.", +"id": "GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraint", +"properties": { +"countryCriterion": { +"description": "Geo target constant resource name of the country in which serving is constrained.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraintList": { +"description": "A list of countries where a resource's serving is constrained.", +"id": "GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraintList", +"properties": { +"countries": { +"description": "Countries in which serving is restricted.", +"items": { +"$ref": "GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraint" +}, +"type": "array" +}, +"totalTargetedCountries": { +"description": "Total number of countries targeted by the resource.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Common_PolicyTopicConstraint_ResellerConstraint": { +"description": "Indicates that a policy topic was constrained due to disapproval of the website for reseller purposes.", +"id": "GoogleAdsSearchads360V23Common_PolicyTopicConstraint_ResellerConstraint", +"properties": {}, +"type": "object" +}, +"GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationMismatch": { +"description": "Evidence of mismatches between the URLs of a resource.", +"id": "GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationMismatch", +"properties": { +"urlTypes": { +"description": "The set of URLs that did not match each other.", +"items": { +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"DISPLAY_URL", +"FINAL_URL", +"FINAL_MOBILE_URL", +"TRACKING_URL", +"MOBILE_TRACKING_URL" +], +"enumDescriptions": [ +"No value has been specified.", +"The received value is not known in this version. This is a response-only value.", +"The display url.", +"The final url.", +"The final mobile url.", +"The tracking url template, with substituted desktop url.", +"The tracking url template, with substituted mobile url." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationNotWorking": { +"description": "Evidence details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices.", +"id": "GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationNotWorking", +"properties": { +"device": { +"description": "The type of device that failed to load the URL.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"DESKTOP", +"ANDROID", +"IOS" +], +"enumDescriptions": [ +"No value has been specified.", +"The received value is not known in this version. This is a response-only value.", +"Landing page doesn't work on desktop device.", +"Landing page doesn't work on Android device.", +"Landing page doesn't work on iOS device." +], +"type": "string" +}, +"dnsErrorType": { +"description": "The type of DNS error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"HOSTNAME_NOT_FOUND", +"GOOGLE_CRAWLER_DNS_ISSUE" +], +"enumDescriptions": [ +"No value has been specified.", +"The received value is not known in this version. This is a response-only value.", +"Host name not found in DNS when fetching landing page.", +"Google internal crawler issue when communicating with DNS. This error doesn't mean the landing page doesn't work. Google will recrawl the landing page." +], +"type": "string" +}, +"expandedUrl": { +"description": "The full URL that didn't work.", +"type": "string" +}, +"httpErrorCode": { +"description": "The HTTP error code.", +"format": "int64", +"type": "string" +}, +"lastCheckedDateTime": { +"description": "The time the URL was last checked. The format is \"YYYY-MM-DD HH:MM:SS\". Examples: \"2018-03-05 09:15:00\" or \"2018-02-01 14:34:30\"", +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationTextList": { +"description": "A list of strings found in a destination page that caused a policy finding.", +"id": "GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationTextList", +"properties": { +"destinationTexts": { +"description": "List of text found in the resource's destination page.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Common_PolicyTopicEvidence_TextList": { +"description": "A list of fragments of text that violated a policy.", +"id": "GoogleAdsSearchads360V23Common_PolicyTopicEvidence_TextList", +"properties": { +"texts": { +"description": "The fragments of text from the resource that caused the policy finding.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Common_PolicyTopicEvidence_WebsiteList": { +"description": "A list of websites that caused a policy finding. Used for ONE_WEBSITE_PER_AD_GROUP policy topic, for example. In case there are more than five websites, only the top five (those that appear in resources the most) will be listed here.", +"id": "GoogleAdsSearchads360V23Common_PolicyTopicEvidence_WebsiteList", +"properties": { +"websites": { +"description": "Websites that caused the policy finding.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Common__PolicyTopicConstraint": { +"description": "Describes the effect on serving that a policy topic entry will have.", +"id": "GoogleAdsSearchads360V23Common__PolicyTopicConstraint", +"properties": { +"certificateDomainMismatchInCountryList": { +"$ref": "GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraintList", +"description": "Countries where the resource's domain is not covered by the certificates associated with it." +}, +"certificateMissingInCountryList": { +"$ref": "GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraintList", +"description": "Countries where a certificate is required for serving." +}, +"countryConstraintList": { +"$ref": "GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraintList", +"description": "Countries where the resource cannot serve." +}, +"resellerConstraint": { +"$ref": "GoogleAdsSearchads360V23Common_PolicyTopicConstraint_ResellerConstraint", +"description": "Reseller constraint." +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Common__PolicyTopicEntry": { +"description": "Policy finding attached to a resource (for example, alcohol policy associated with a site that sells alcohol). Each PolicyTopicEntry has a topic that indicates the specific ads policy the entry is about and a type to indicate the effect that the entry will have on serving. It may optionally have one or more evidences that indicate the reason for the finding. It may also optionally have one or more constraints that provide details about how serving may be restricted.", +"id": "GoogleAdsSearchads360V23Common__PolicyTopicEntry", +"properties": { +"constraints": { +"description": "Indicates how serving of this resource may be affected (for example, not serving in a country).", +"items": { +"$ref": "GoogleAdsSearchads360V23Common__PolicyTopicConstraint" +}, +"type": "array" +}, +"evidences": { +"description": "Additional information that explains policy finding (for example, the brand name for a trademark finding).", +"items": { +"$ref": "GoogleAdsSearchads360V23Common__PolicyTopicEvidence" +}, +"type": "array" +}, +"topic": { +"description": "Policy topic this finding refers to. For example, \"ALCOHOL\", \"TRADEMARKS_IN_AD_TEXT\", or \"DESTINATION_NOT_WORKING\". The set of possible policy topics is not fixed for a particular API version and may change at any time.", +"type": "string" +}, +"type": { +"description": "Describes the negative or positive effect this policy will have on serving.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"PROHIBITED", +"LIMITED", +"FULLY_LIMITED", +"DESCRIPTIVE", +"BROADENING", +"AREA_OF_INTEREST_ONLY" +], +"enumDescriptions": [ +"No value has been specified.", +"The received value is not known in this version. This is a response-only value.", +"The resource will not be served.", +"The resource will not be served under some circumstances.", +"The resource cannot serve at all because of the current targeting criteria.", +"May be of interest, but does not limit how the resource is served.", +"Could increase coverage beyond normal.", +"Constrained for all targeted countries, but may serve in other countries through area of interest." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Common__PolicyTopicEvidence": { +"description": "Additional information that explains a policy finding.", +"id": "GoogleAdsSearchads360V23Common__PolicyTopicEvidence", +"properties": { +"destinationMismatch": { +"$ref": "GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationMismatch", +"description": "Mismatch between the destinations of a resource's URLs." +}, +"destinationNotWorking": { +"$ref": "GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationNotWorking", +"description": "Details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices." +}, +"destinationTextList": { +"$ref": "GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationTextList", +"description": "The text in the destination of the resource that is causing a policy finding." +}, +"languageCode": { +"description": "The language the resource was detected to be written in. This is an IETF language tag such as \"en-US\".", +"type": "string" +}, +"textList": { +"$ref": "GoogleAdsSearchads360V23Common_PolicyTopicEvidence_TextList", +"description": "List of evidence found in the text of a resource." +}, +"websiteList": { +"$ref": "GoogleAdsSearchads360V23Common_PolicyTopicEvidence_WebsiteList", +"description": "List of websites linked with this resource." +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Common__PolicyViolationKey": { +"description": "Key of the violation. The key is used for referring to a violation when filing an exemption request.", +"id": "GoogleAdsSearchads360V23Common__PolicyViolationKey", +"properties": { +"policyName": { +"description": "Unique ID of the violated policy.", +"type": "string" +}, +"violatingText": { +"description": "The text that violates the policy if specified. Otherwise, refers to the policy in general (for example, when requesting to be exempt from the whole policy). If not specified for criterion exemptions, the whole policy is implied. Must be specified for ad exemptions.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Common__Value": { +"description": "A generic data container.", +"id": "GoogleAdsSearchads360V23Common__Value", +"properties": { +"booleanValue": { +"description": "A boolean.", +"type": "boolean" +}, +"doubleValue": { +"description": "A double.", +"format": "double", +"type": "number" +}, +"floatValue": { +"description": "A float.", +"format": "float", +"type": "number" +}, +"int64Value": { +"description": "An int64.", +"format": "int64", +"type": "string" +}, +"stringValue": { +"description": "A string.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Errors_ErrorLocation_FieldPathElement": { +"description": "A part of a field path.", +"id": "GoogleAdsSearchads360V23Errors_ErrorLocation_FieldPathElement", +"properties": { +"fieldName": { +"description": "The name of a field or a oneof", +"type": "string" +}, +"index": { +"description": "If field_name is a repeated field, this is the element that failed", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Errors__BudgetPerDayMinimumErrorDetails": { +"description": "Error details for a budget below per-day minimum error.", +"id": "GoogleAdsSearchads360V23Errors__BudgetPerDayMinimumErrorDetails", +"properties": { +"budgetPerDayMinimumMicros": { +"description": "The minimum budget required by the campaign per day, in micros of the advertiser currency. Applies to both daily and custom budgets.", +"format": "int64", +"type": "string" +}, +"currencyCode": { +"description": "The advertiser's currency, represented as a three-letter ISO 4217 currency code (such as \"USD\").", +"type": "string" +}, +"failedBudgetAmountMicros": { +"description": "The budget amount value that was rejected as too low, in micros of the advertiser currency. Only set if this error is caused by the amount field value.", +"format": "int64", +"type": "string" +}, +"failedBudgetTotalAmountMicros": { +"description": "The budget total_amount value that was rejected as too low, in micros of the advertiser currency. Only set if this error is caused by the total_amount field value.", +"format": "int64", +"type": "string" +}, +"minimumBudgetAmountMicros": { +"description": "The minimum value for the budget's amount field required by the campaign, in micros of the advertiser currency. Only set if this error is caused by the amount field value.", +"format": "int64", +"type": "string" +}, +"minimumBudgetTotalAmountMicros": { +"description": "The minimum value for the budget's total_amount field required by the campaign given its configured start and end time, in micros of the advertiser currency. Only set if this error is caused by the total_amount field value.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Errors__ErrorCode": { +"description": "The error reason represented by type and enum.", +"id": "GoogleAdsSearchads360V23Errors__ErrorCode", +"properties": { +"accessInvitationError": { +"description": "The reasons for the access invitation error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_EMAIL_ADDRESS", +"EMAIL_ADDRESS_ALREADY_HAS_ACCESS", +"INVALID_INVITATION_STATUS", +"GOOGLE_CONSUMER_ACCOUNT_NOT_ALLOWED", +"INVALID_INVITATION_ID", +"EMAIL_ADDRESS_ALREADY_HAS_PENDING_INVITATION", +"PENDING_INVITATIONS_LIMIT_EXCEEDED", +"EMAIL_DOMAIN_POLICY_VIOLATED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The email address is invalid for sending an invitation.", +"Email address already has access to this customer.", +"Invalid invitation status for the operation.", +"Email address cannot be like abc+foo@google.com.", +"Invalid invitation ID.", +"Email address already has a pending invitation.", +"Pending invitation limit exceeded for the customer.", +"Email address doesn't conform to the email domain policy. See https://support.google.com/google-ads/answer/2375456" +], +"type": "string" +}, +"accountBudgetProposalError": { +"description": "The reasons for account budget proposal errors.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"FIELD_MASK_NOT_ALLOWED", +"IMMUTABLE_FIELD", +"REQUIRED_FIELD_MISSING", +"CANNOT_CANCEL_APPROVED_PROPOSAL", +"CANNOT_REMOVE_UNAPPROVED_BUDGET", +"CANNOT_REMOVE_RUNNING_BUDGET", +"CANNOT_END_UNAPPROVED_BUDGET", +"CANNOT_END_INACTIVE_BUDGET", +"BUDGET_NAME_REQUIRED", +"CANNOT_UPDATE_OLD_BUDGET", +"CANNOT_END_IN_PAST", +"CANNOT_EXTEND_END_TIME", +"PURCHASE_ORDER_NUMBER_REQUIRED", +"PENDING_UPDATE_PROPOSAL_EXISTS", +"MULTIPLE_BUDGETS_NOT_ALLOWED_FOR_UNAPPROVED_BILLING_SETUP", +"CANNOT_UPDATE_START_TIME_FOR_STARTED_BUDGET", +"SPENDING_LIMIT_LOWER_THAN_ACCRUED_COST_NOT_ALLOWED", +"UPDATE_IS_NO_OP", +"END_TIME_MUST_FOLLOW_START_TIME", +"BUDGET_DATE_RANGE_INCOMPATIBLE_WITH_BILLING_SETUP", +"NOT_AUTHORIZED", +"INVALID_BILLING_SETUP", +"OVERLAPS_EXISTING_BUDGET", +"CANNOT_CREATE_BUDGET_THROUGH_API", +"INVALID_MASTER_SERVICE_AGREEMENT", +"CANCELED_BILLING_SETUP" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The field mask must be empty for create/end/remove proposals.", +"The field cannot be set because of the proposal type.", +"The field is required because of the proposal type.", +"Proposals that have been approved cannot be cancelled.", +"Budgets that haven't been approved cannot be removed.", +"Budgets that are currently running cannot be removed.", +"Budgets that haven't been approved cannot be truncated.", +"Only budgets that are currently running can be truncated.", +"All budgets must have names.", +"Expired budgets cannot be edited after a sufficient amount of time has passed.", +"It is not permissible a propose a new budget that ends in the past.", +"An expired budget cannot be extended to overlap with the running budget.", +"A purchase order number is required.", +"Budgets that have a pending update cannot be updated.", +"Cannot propose more than one budget when the corresponding billing setup hasn't been approved.", +"Cannot update the start time of a budget that has already started.", +"Cannot update the spending limit of a budget with an amount lower than what has already been spent.", +"Cannot propose a budget update without actually changing any fields.", +"The end time must come after the start time.", +"The budget's date range must fall within the date range of its billing setup.", +"The user is not authorized to mutate budgets for the given billing setup.", +"Mutates are not allowed for the given billing setup.", +"Budget creation failed as it overlaps with a pending budget proposal or an approved budget.", +"The control setting in user's payments profile doesn't allow budget creation through API. Log in to Google Ads to create budget.", +"Master service agreement has not been signed yet for the Payments Profile.", +"Budget mutates are not allowed because the given billing setup is canceled." +], +"type": "string" +}, +"accountLinkError": { +"description": "The reasons for the account link status change error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_STATUS", +"PERMISSION_DENIED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The new link status is invalid.", +"The authenticated user doesn't have the permission to do the change." +], +"type": "string" +}, +"adCustomizerError": { +"description": "The reasons for the ad customizer error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"COUNTDOWN_INVALID_DATE_FORMAT", +"COUNTDOWN_DATE_IN_PAST", +"COUNTDOWN_INVALID_LOCALE", +"COUNTDOWN_INVALID_START_DAYS_BEFORE", +"UNKNOWN_USER_LIST" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Invalid date argument in countdown function.", +"Countdown end date is in the past.", +"Invalid locale string in countdown function.", +"Days-before argument to countdown function is not positive.", +"A user list referenced in an IF function does not exist." +], +"type": "string" +}, +"adError": { +"description": "An error with an Ad Group Ad mutate.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"AD_CUSTOMIZERS_NOT_SUPPORTED_FOR_AD_TYPE", +"APPROXIMATELY_TOO_LONG", +"APPROXIMATELY_TOO_SHORT", +"BAD_SNIPPET", +"CANNOT_MODIFY_AD", +"CANNOT_SET_BUSINESS_NAME_IF_URL_SET", +"CANNOT_SET_FIELD", +"CANNOT_SET_FIELD_WITH_ORIGIN_AD_ID_SET", +"CANNOT_SET_FIELD_WITH_AD_ID_SET_FOR_SHARING", +"CANNOT_SET_ALLOW_FLEXIBLE_COLOR_FALSE", +"CANNOT_SET_COLOR_CONTROL_WHEN_NATIVE_FORMAT_SETTING", +"CANNOT_SET_URL", +"CANNOT_SET_WITHOUT_FINAL_URLS", +"CANNOT_SET_WITH_FINAL_URLS", +"CANNOT_SET_WITH_URL_DATA", +"CANNOT_USE_AD_SUBCLASS_FOR_OPERATOR", +"CUSTOMER_NOT_APPROVED_MOBILEADS", +"CUSTOMER_NOT_APPROVED_THIRDPARTY_ADS", +"CUSTOMER_NOT_APPROVED_THIRDPARTY_REDIRECT_ADS", +"CUSTOMER_NOT_ELIGIBLE", +"CUSTOMER_NOT_ELIGIBLE_FOR_UPDATING_BEACON_URL", +"DIMENSION_ALREADY_IN_UNION", +"DIMENSION_MUST_BE_SET", +"DIMENSION_NOT_IN_UNION", +"DISPLAY_URL_CANNOT_BE_SPECIFIED", +"DOMESTIC_PHONE_NUMBER_FORMAT", +"EMERGENCY_PHONE_NUMBER", +"EMPTY_FIELD", +"FEED_ATTRIBUTE_MUST_HAVE_MAPPING_FOR_TYPE_ID", +"FEED_ATTRIBUTE_MAPPING_TYPE_MISMATCH", +"ILLEGAL_AD_CUSTOMIZER_TAG_USE", +"ILLEGAL_TAG_USE", +"INCONSISTENT_DIMENSIONS", +"INCONSISTENT_STATUS_IN_TEMPLATE_UNION", +"INCORRECT_LENGTH", +"INELIGIBLE_FOR_UPGRADE", +"INVALID_AD_ADDRESS_CAMPAIGN_TARGET", +"INVALID_AD_TYPE", +"INVALID_ATTRIBUTES_FOR_MOBILE_IMAGE", +"INVALID_ATTRIBUTES_FOR_MOBILE_TEXT", +"INVALID_CALL_TO_ACTION_TEXT", +"INVALID_CHARACTER_FOR_URL", +"INVALID_COUNTRY_CODE", +"INVALID_EXPANDED_DYNAMIC_SEARCH_AD_TAG", +"INVALID_INPUT", +"INVALID_MARKUP_LANGUAGE", +"INVALID_MOBILE_CARRIER", +"INVALID_MOBILE_CARRIER_TARGET", +"INVALID_NUMBER_OF_ELEMENTS", +"INVALID_PHONE_NUMBER_FORMAT", +"INVALID_RICH_MEDIA_CERTIFIED_VENDOR_FORMAT_ID", +"INVALID_TEMPLATE_DATA", +"INVALID_TEMPLATE_ELEMENT_FIELD_TYPE", +"INVALID_TEMPLATE_ID", +"LINE_TOO_WIDE", +"MISSING_AD_CUSTOMIZER_MAPPING", +"MISSING_ADDRESS_COMPONENT", +"MISSING_ADVERTISEMENT_NAME", +"MISSING_BUSINESS_NAME", +"MISSING_DESCRIPTION1", +"MISSING_DESCRIPTION2", +"MISSING_DESTINATION_URL_TAG", +"MISSING_LANDING_PAGE_URL_TAG", +"MISSING_DIMENSION", +"MISSING_DISPLAY_URL", +"MISSING_HEADLINE", +"MISSING_HEIGHT", +"MISSING_IMAGE", +"MISSING_MARKETING_IMAGE_OR_PRODUCT_VIDEOS", +"MISSING_MARKUP_LANGUAGES", +"MISSING_MOBILE_CARRIER", +"MISSING_PHONE", +"MISSING_REQUIRED_TEMPLATE_FIELDS", +"MISSING_TEMPLATE_FIELD_VALUE", +"MISSING_TEXT", +"MISSING_VISIBLE_URL", +"MISSING_WIDTH", +"MULTIPLE_DISTINCT_FEEDS_UNSUPPORTED", +"MUST_USE_TEMP_AD_UNION_ID_ON_ADD", +"TOO_LONG", +"TOO_SHORT", +"UNION_DIMENSIONS_CANNOT_CHANGE", +"UNKNOWN_ADDRESS_COMPONENT", +"UNKNOWN_FIELD_NAME", +"UNKNOWN_UNIQUE_NAME", +"UNSUPPORTED_DIMENSIONS", +"URL_INVALID_SCHEME", +"URL_INVALID_TOP_LEVEL_DOMAIN", +"URL_MALFORMED", +"URL_NO_HOST", +"URL_NOT_EQUIVALENT", +"URL_HOST_NAME_TOO_LONG", +"URL_NO_SCHEME", +"URL_NO_TOP_LEVEL_DOMAIN", +"URL_PATH_NOT_ALLOWED", +"URL_PORT_NOT_ALLOWED", +"URL_QUERY_NOT_ALLOWED", +"URL_SCHEME_BEFORE_EXPANDED_DYNAMIC_SEARCH_AD_TAG", +"USER_DOES_NOT_HAVE_ACCESS_TO_TEMPLATE", +"INCONSISTENT_EXPANDABLE_SETTINGS", +"INVALID_FORMAT", +"INVALID_FIELD_TEXT", +"ELEMENT_NOT_PRESENT", +"IMAGE_ERROR", +"VALUE_NOT_IN_RANGE", +"FIELD_NOT_PRESENT", +"ADDRESS_NOT_COMPLETE", +"ADDRESS_INVALID", +"VIDEO_RETRIEVAL_ERROR", +"AUDIO_ERROR", +"INVALID_YOUTUBE_DISPLAY_URL", +"TOO_MANY_PRODUCT_IMAGES", +"TOO_MANY_PRODUCT_VIDEOS", +"INCOMPATIBLE_AD_TYPE_AND_DEVICE_PREFERENCE", +"CALLTRACKING_NOT_SUPPORTED_FOR_COUNTRY", +"CARRIER_SPECIFIC_SHORT_NUMBER_NOT_ALLOWED", +"DISALLOWED_NUMBER_TYPE", +"PHONE_NUMBER_NOT_SUPPORTED_FOR_COUNTRY", +"PHONE_NUMBER_NOT_SUPPORTED_WITH_CALLTRACKING_FOR_COUNTRY", +"PREMIUM_RATE_NUMBER_NOT_ALLOWED", +"VANITY_PHONE_NUMBER_NOT_ALLOWED", +"INVALID_CALL_CONVERSION_TYPE_ID", +"CANNOT_DISABLE_CALL_CONVERSION_AND_SET_CONVERSION_TYPE_ID", +"CANNOT_SET_PATH2_WITHOUT_PATH1", +"MISSING_DYNAMIC_SEARCH_ADS_SETTING_DOMAIN_NAME", +"INCOMPATIBLE_WITH_RESTRICTION_TYPE", +"CUSTOMER_CONSENT_FOR_CALL_RECORDING_REQUIRED", +"MISSING_IMAGE_OR_MEDIA_BUNDLE", +"PRODUCT_TYPE_NOT_SUPPORTED_IN_THIS_CAMPAIGN", +"PLACEHOLDER_CANNOT_HAVE_EMPTY_DEFAULT_VALUE", +"PLACEHOLDER_COUNTDOWN_FUNCTION_CANNOT_HAVE_DEFAULT_VALUE", +"PLACEHOLDER_DEFAULT_VALUE_MISSING", +"UNEXPECTED_PLACEHOLDER_DEFAULT_VALUE", +"AD_CUSTOMIZERS_MAY_NOT_BE_ADJACENT", +"UPDATING_AD_WITH_NO_ENABLED_ASSOCIATION", +"CALL_AD_VERIFICATION_URL_FINAL_URL_DOES_NOT_HAVE_SAME_DOMAIN", +"CALL_AD_FINAL_URL_AND_VERIFICATION_URL_CANNOT_BOTH_BE_EMPTY", +"TOO_MANY_AD_CUSTOMIZERS", +"INVALID_AD_CUSTOMIZER_FORMAT", +"NESTED_AD_CUSTOMIZER_SYNTAX", +"UNSUPPORTED_AD_CUSTOMIZER_SYNTAX", +"UNPAIRED_BRACE_IN_AD_CUSTOMIZER_TAG", +"MORE_THAN_ONE_COUNTDOWN_TAG_TYPE_EXISTS", +"DATE_TIME_IN_COUNTDOWN_TAG_IS_INVALID", +"DATE_TIME_IN_COUNTDOWN_TAG_IS_PAST", +"UNRECOGNIZED_AD_CUSTOMIZER_TAG_FOUND", +"CUSTOMIZER_TYPE_FORBIDDEN_FOR_FIELD", +"INVALID_CUSTOMIZER_ATTRIBUTE_NAME", +"STORE_MISMATCH", +"MISSING_REQUIRED_IMAGE_ASPECT_RATIO", +"MISMATCHED_ASPECT_RATIOS", +"DUPLICATE_IMAGE_ACROSS_CAROUSEL_CARDS", +"INVALID_YOUTUBE_VIDEO_ASSET_ID_FOR_VIDEO_ADS_SEQUENCING" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Ad customizers are not supported for ad type.", +"Estimating character sizes the string is too long.", +"Estimating character sizes the string is too short.", +"There is a problem with the snippet.", +"Cannot modify an ad.", +"business name and url cannot be set at the same time", +"The specified field is incompatible with this ad's type or settings.", +"Cannot set field when originAdId is set.", +"Cannot set field when an existing ad id is set for sharing.", +"Cannot set allowFlexibleColor false if no color is provided by user.", +"When user select native, no color control is allowed because we will always respect publisher color for native format serving.", +"Cannot specify a url for the ad type", +"Cannot specify a tracking or mobile url without also setting final urls", +"Cannot specify a legacy url and a final url simultaneously", +"Cannot specify a urls in UrlData and in template fields simultaneously.", +"This operator cannot be used with a subclass of Ad.", +"Customer is not approved for mobile ads.", +"Customer is not approved for 3PAS richmedia ads.", +"Customer is not approved for 3PAS redirect richmedia (Ad Exchange) ads.", +"Not an eligible customer", +"Customer is not eligible for updating beacon url", +"There already exists an ad with the same dimensions in the union.", +"Ad's dimension must be set before setting union dimension.", +"Ad's dimension must be included in the union dimensions.", +"Display Url cannot be specified (applies to Ad Exchange Ads)", +"Telephone number contains invalid characters or invalid format. Re-enter your number using digits (0-9), dashes (-), and parentheses only.", +"Emergency telephone numbers are not allowed. Enter a valid domestic phone number to connect customers to your business.", +"A required field was not specified or is an empty string.", +"A feed attribute referenced in an ad customizer tag is not in the ad customizer mapping for the feed.", +"The ad customizer field mapping for the feed attribute does not match the expected field type.", +"The use of ad customizer tags in the ad text is disallowed. Details in trigger.", +"Tags of the form {PH_x}, where x is a number, are disallowed in ad text.", +"The dimensions of the ad are specified or derived in multiple ways and are not consistent.", +"The status cannot differ among template ads of the same union.", +"The length of the string is not valid.", +"The ad is ineligible for upgrade.", +"User cannot create mobile ad for countries targeted in specified campaign.", +"Invalid Ad type. A specific type of Ad is required.", +"Headline, description or phone cannot be present when creating mobile image ad.", +"Image cannot be present when creating mobile text ad.", +"Invalid call to action text.", +"Invalid character in URL.", +"Creative's country code is not valid.", +"Invalid use of Expanded Dynamic Search Ads tags ({lpurl} etc.)", +"An input error whose real reason was not properly mapped (should not happen).", +"An invalid markup language was entered.", +"An invalid mobile carrier was entered.", +"Specified mobile carriers target a country not targeted by the campaign.", +"Wrong number of elements for given element type", +"The format of the telephone number is incorrect. Re-enter the number using the correct format.", +"The certified vendor format id is incorrect.", +"The template ad data contains validation errors.", +"The template field doesn't have have the correct type.", +"Invalid template id.", +"After substituting replacement strings, the line is too wide.", +"The feed referenced must have ad customizer mapping to be used in a customizer tag.", +"Missing address component in template element address field.", +"An ad name must be entered.", +"Business name must be entered.", +"Description (line 2) must be entered.", +"Description (line 3) must be entered.", +"The destination url must contain at least one tag (for example, {lpurl})", +"The tracking url template of ExpandedDynamicSearchAd must contain at least one tag. (for example, {lpurl})", +"A valid dimension must be specified for this ad.", +"A display URL must be entered.", +"Headline must be entered.", +"A height must be entered.", +"An image must be entered.", +"Marketing image or product videos are required.", +"The markup language in which your site is written must be entered.", +"A mobile carrier must be entered.", +"Phone number must be entered.", +"Missing required template fields", +"Missing a required field value", +"The ad must have text.", +"A visible URL must be entered.", +"A width must be entered.", +"Only 1 feed can be used as the source of ad customizer substitutions in a single ad.", +"TempAdUnionId must be use when adding template ads.", +"The string has too many characters.", +"The string has too few characters.", +"Ad union dimensions cannot change for saved ads.", +"Address component is not {country, lat, lng}.", +"Unknown unique field name", +"Unknown unique name (template element type specifier)", +"Unsupported ad dimension", +"URL starts with an invalid scheme.", +"URL ends with an invalid top-level domain name.", +"URL contains illegal characters.", +"URL must contain a host name.", +"URL not equivalent during upgrade.", +"URL host name too long to be stored as visible URL (applies to Ad Exchange ads)", +"URL must start with a scheme.", +"URL should end in a valid domain extension, such as .com or .net.", +"URL must not end with a path.", +"URL must not specify a port.", +"URL must not contain a query.", +"A url scheme is not allowed in front of tag in tracking url template (for example, http://{lpurl})", +"The user does not have permissions to create a template ad for the given template.", +"Expandable setting is inconsistent/wrong. For example, an AdX ad is invalid if it has a expandable vendor format but no expanding directions specified, or expanding directions is specified, but the vendor format is not expandable.", +"Format is invalid", +"The text of this field did not match a pattern of allowed values.", +"Template element is mising", +"Error occurred during image processing", +"The value is not within the valid range", +"Template element field is not present", +"Address is incomplete", +"Invalid address", +"Error retrieving specified video", +"Error processing audio", +"Display URL is incorrect for YouTube PYV ads", +"Too many product Images in GmailAd", +"Too many product Videos in GmailAd", +"The device preference is not compatible with the ad type", +"Call tracking is not supported for specified country.", +"Carrier specific short number is not allowed.", +"Specified phone number type is disallowed.", +"Phone number not supported for country.", +"Phone number not supported with call tracking enabled for country.", +"Premium rate phone number is not allowed.", +"Vanity phone number is not allowed.", +"Invalid call conversion type id.", +"Cannot disable call conversion and set conversion type id.", +"Cannot set path2 without path1.", +"Missing domain name in campaign setting when adding expanded dynamic search ad.", +"The associated ad is not compatible with restriction type.", +"Consent for call recording is required for creating/updating call only ads. See https://support.google.com/google-ads/answer/7412639.", +"Either an image or a media bundle is required in a display upload ad.", +"The display upload product type is not supported in this campaign.", +"The default value of an ad placeholder can not be the empty string.", +"Ad placeholders with countdown functions must not have a default value.", +"A previous ad placeholder that had a default value was found which means that all (non-countdown) placeholders must have a default value. This ad placeholder does not have a default value.", +"A previous ad placeholder that did not have a default value was found which means that no placeholders may have a default value. This ad placeholder does have a default value.", +"Two ad customizers may not be directly adjacent in an ad text. They must be separated by at least one character.", +"The ad is not associated with any enabled AdGroupAd, and cannot be updated.", +"Call Ad verification url and final url don't have same domain.", +"Final url and verification url cannot both be empty for call ads.", +"Too many ad customizers in one asset.", +"The ad customizer tag is recognized, but the format is invalid.", +"Customizer tags cannot be nested.", +"The ad customizer syntax used in the ad is not supported.", +"There exists unpaired brace in the ad customizer tag.", +"More than one type of countdown tag exists among all text lines.", +"Date time in the countdown tag is invalid.", +"Date time in the countdown tag is in the past.", +"Cannot recognize the ad customizer tag.", +"Customizer type forbidden for this field.", +"Customizer attribute name is invalid.", +"App store value does not match the value of the app store in the app specified in the campaign.", +"Missing required image aspect ratio.", +"Aspect ratios mismatch between different assets.", +"Images must be unique between different carousel card assets.", +"For video ads sequencing, YouTube video asset ID has to be defined in `campaign.video_campaign_settings.video_ad_sequence.steps.asset_id`." +], +"type": "string" +}, +"adGroupAdError": { +"description": "The reasons for the ad group ad error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"AD_GROUP_AD_LABEL_DOES_NOT_EXIST", +"AD_GROUP_AD_LABEL_ALREADY_EXISTS", +"AD_NOT_UNDER_ADGROUP", +"CANNOT_OPERATE_ON_REMOVED_ADGROUPAD", +"CANNOT_CREATE_DEPRECATED_ADS", +"CANNOT_CREATE_TEXT_ADS", +"EMPTY_FIELD", +"RESOURCE_REFERENCED_IN_MULTIPLE_OPS", +"AD_TYPE_CANNOT_BE_PAUSED", +"AD_TYPE_CANNOT_BE_REMOVED", +"CANNOT_UPDATE_DEPRECATED_ADS", +"AD_SHARING_NOT_ALLOWED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"No link found between the adgroup ad and the label.", +"The label has already been attached to the adgroup ad.", +"The specified ad was not found in the adgroup", +"Removed ads may not be modified", +"An ad of this type is deprecated and cannot be created. Only deletions are permitted.", +"Text ads are deprecated and cannot be created. Use expanded text ads instead.", +"A required field was not specified or is an empty string.", +"An ad may only be modified once per call", +"AdGroupAds with the given ad type cannot be paused.", +"AdGroupAds with the given ad type cannot be removed.", +"An ad of this type is deprecated and cannot be updated. Only removals are permitted.", +"Ad sharing is not allowed." +], +"type": "string" +}, +"adGroupBidModifierError": { +"description": "The reasons for the ad group bid modifier error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CRITERION_ID_NOT_SUPPORTED", +"CANNOT_OVERRIDE_OPTED_OUT_CAMPAIGN_CRITERION_BID_MODIFIER" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The criterion ID does not support bid modification.", +"Cannot override the bid modifier for the given criterion ID if the parent campaign is opted out of the same criterion." +], +"type": "string" +}, +"adGroupCriterionCustomizerError": { +"description": "The reasons for the ad group criterion customizer error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CRITERION_IS_NOT_KEYWORD" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Only keyword type criterion is allowed to link customizer attribute." +], +"type": "string" +}, +"adGroupCriterionError": { +"description": "Indicates failure to properly authenticate user.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"AD_GROUP_CRITERION_LABEL_DOES_NOT_EXIST", +"AD_GROUP_CRITERION_LABEL_ALREADY_EXISTS", +"CANNOT_ADD_LABEL_TO_NEGATIVE_CRITERION", +"TOO_MANY_OPERATIONS", +"CANT_UPDATE_NEGATIVE", +"CONCRETE_TYPE_REQUIRED", +"BID_INCOMPATIBLE_WITH_ADGROUP", +"CANNOT_TARGET_AND_EXCLUDE", +"ILLEGAL_URL", +"INVALID_KEYWORD_TEXT", +"INVALID_DESTINATION_URL", +"MISSING_DESTINATION_URL_TAG", +"KEYWORD_LEVEL_BID_NOT_SUPPORTED_FOR_MANUALCPM", +"INVALID_USER_STATUS", +"CANNOT_ADD_CRITERIA_TYPE", +"CANNOT_EXCLUDE_CRITERIA_TYPE", +"CAMPAIGN_TYPE_NOT_COMPATIBLE_WITH_PARTIAL_FAILURE", +"OPERATIONS_FOR_TOO_MANY_SHOPPING_ADGROUPS", +"CANNOT_MODIFY_URL_FIELDS_WITH_DUPLICATE_ELEMENTS", +"CANNOT_SET_WITHOUT_FINAL_URLS", +"CANNOT_CLEAR_FINAL_URLS_IF_FINAL_MOBILE_URLS_EXIST", +"CANNOT_CLEAR_FINAL_URLS_IF_FINAL_APP_URLS_EXIST", +"CANNOT_CLEAR_FINAL_URLS_IF_TRACKING_URL_TEMPLATE_EXISTS", +"CANNOT_CLEAR_FINAL_URLS_IF_URL_CUSTOM_PARAMETERS_EXIST", +"CANNOT_SET_BOTH_DESTINATION_URL_AND_FINAL_URLS", +"CANNOT_SET_BOTH_DESTINATION_URL_AND_TRACKING_URL_TEMPLATE", +"FINAL_URLS_NOT_SUPPORTED_FOR_CRITERION_TYPE", +"FINAL_MOBILE_URLS_NOT_SUPPORTED_FOR_CRITERION_TYPE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"No link found between the AdGroupCriterion and the label.", +"The label has already been attached to the AdGroupCriterion.", +"Negative AdGroupCriterion cannot have labels.", +"Too many operations for a single call.", +"Negative ad group criteria are not updateable.", +"Concrete type of criterion (keyword v.s. placement) is required for ADD and SET operations.", +"Bid is incompatible with ad group's bidding settings.", +"Cannot target and exclude the same criterion at once.", +"The URL of a placement is invalid.", +"Keyword text was invalid.", +"Destination URL was invalid.", +"The destination url must contain at least one tag (for example, {lpurl})", +"Keyword-level cpm bid is not supported", +"For example, cannot add a biddable ad group criterion that had been removed.", +"Criteria type cannot be targeted for the ad group. Either the account is restricted to keywords only, the criteria type is incompatible with the campaign's bidding strategy, or the criteria type can only be applied to campaigns.", +"Criteria type cannot be excluded for the ad group. Refer to the documentation for a specific criterion to check if it is excludable.", +"Partial failure is not supported for shopping campaign mutate operations.", +"Operations in the mutate request changes too many shopping ad groups. Split requests for multiple shopping ad groups across multiple requests.", +"Not allowed to modify url fields of an ad group criterion if there are duplicate elements for that ad group criterion in the request.", +"Cannot set url fields without also setting final urls.", +"Cannot clear final urls if final mobile urls exist.", +"Cannot clear final urls if final app urls exist.", +"Cannot clear final urls if tracking url template exists.", +"Cannot clear final urls if url custom parameters exist.", +"Cannot set both destination url and final urls.", +"Cannot set both destination url and tracking url template.", +"Final urls are not supported for this criterion type.", +"Final mobile urls are not supported for this criterion type." +], +"type": "string" +}, +"adGroupCustomizerError": { +"description": "The reasons for the ad group customizer error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version." +], +"type": "string" +}, +"adGroupError": { +"description": "An error with an Ad Group mutate.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"DUPLICATE_ADGROUP_NAME", +"INVALID_ADGROUP_NAME", +"ADVERTISER_NOT_ON_CONTENT_NETWORK", +"BID_TOO_BIG", +"BID_TYPE_AND_BIDDING_STRATEGY_MISMATCH", +"MISSING_ADGROUP_NAME", +"ADGROUP_LABEL_DOES_NOT_EXIST", +"ADGROUP_LABEL_ALREADY_EXISTS", +"INVALID_CONTENT_BID_CRITERION_TYPE_GROUP", +"AD_GROUP_TYPE_NOT_VALID_FOR_ADVERTISING_CHANNEL_TYPE", +"ADGROUP_TYPE_NOT_SUPPORTED_FOR_CAMPAIGN_SALES_COUNTRY", +"CANNOT_ADD_ADGROUP_OF_TYPE_DSA_TO_CAMPAIGN_WITHOUT_DSA_SETTING", +"PROMOTED_HOTEL_AD_GROUPS_NOT_AVAILABLE_FOR_CUSTOMER", +"INVALID_EXCLUDED_PARENT_ASSET_FIELD_TYPE", +"INVALID_EXCLUDED_PARENT_ASSET_SET_TYPE", +"CANNOT_ADD_AD_GROUP_FOR_CAMPAIGN_TYPE", +"INVALID_STATUS", +"INVALID_STEP_ID_FOR_VIDEO_ADS_SEQUENCING", +"INVALID_AD_GROUP_TYPE_FOR_VIDEO_ADS_SEQUENCING", +"DUPLICATE_STEP_ID", +"INVALID_VERTICAL_ADS_FORMAT_SETTING", +"VERTICAL_ADS_FORMAT_SETTING_NOT_SUPPORTED_FOR_CAMPAIGNS_WITHOUT_AI_MAX", +"VERTICAL_ADS_FORMAT_SETTING_NOT_SUPPORTED_FOR_CAMPAIGNS_WITHOUT_ENABLED_TRAVEL_FEED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"AdGroup with the same name already exists for the campaign.", +"AdGroup name is not valid.", +"Advertiser is not allowed to target sites or set site bids that are not on the Google Search Network.", +"Bid amount is too big.", +"AdGroup bid does not match the campaign's bidding strategy.", +"AdGroup name is required for Add.", +"No link found between the ad group and the label.", +"The label has already been attached to the ad group.", +"The CriterionTypeGroup is not supported for the content bid dimension.", +"The ad group type is not compatible with the campaign channel type.", +"The ad group type is not supported in the country of sale of the campaign.", +"Ad groups of AdGroupType.SEARCH_DYNAMIC_ADS can only be added to campaigns that have DynamicSearchAdsSetting attached.", +"Promoted hotels ad groups are only available to customers on the allow-list.", +"The field type cannot be excluded because an active ad group-asset link of this type exists.", +"The asset set type is invalid for setting the excluded_parent_asset_set_types field.", +"Cannot add ad groups for the campaign type.", +"Invalid status for the ad group.", +"For video ads sequencing, AdGroup `step_id` has to use a `step_id` defined in `campaign.video_campaign_settings.video_ad_sequence`.", +"For video ads sequencing, AdGroup type has to use a type defined in `campaign.video_campaign_settings.video_ad_sequence`.", +"Only one AdGroup is allowed for each step ID in video ads sequencing.", +"At least one Vertical Ads format must be enabled for a campaign under Travel Ads in Search Campaigns.", +"AI max setting must be enabled to enable Vertical Ads formats for a campaign under Travel Ads in Search Campaigns.", +"An enabled travel feed must be linked to enable Vertical Ads formats for a campaign under Travel Ads in Search Campaigns." +], +"type": "string" +}, +"adGroupFeedError": { +"description": "The reasons for the ad group feed error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"FEED_ALREADY_EXISTS_FOR_PLACEHOLDER_TYPE", +"CANNOT_CREATE_FOR_REMOVED_FEED", +"ADGROUP_FEED_ALREADY_EXISTS", +"CANNOT_OPERATE_ON_REMOVED_ADGROUP_FEED", +"INVALID_PLACEHOLDER_TYPE", +"MISSING_FEEDMAPPING_FOR_PLACEHOLDER_TYPE", +"NO_EXISTING_LOCATION_CUSTOMER_FEED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"An active feed already exists for this ad group and place holder type.", +"The specified feed is removed.", +"The AdGroupFeed already exists. UPDATE operation should be used to modify the existing AdGroupFeed.", +"Cannot operate on removed AdGroupFeed.", +"Invalid placeholder type.", +"Feed mapping for this placeholder type does not exist.", +"Location AdGroupFeeds cannot be created unless there is a location CustomerFeed for the specified feed." +], +"type": "string" +}, +"adParameterError": { +"description": "The reasons for the ad parameter error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"AD_GROUP_CRITERION_MUST_BE_KEYWORD", +"INVALID_INSERTION_TEXT_FORMAT" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The ad group criterion must be a keyword criterion.", +"The insertion text is invalid." +], +"type": "string" +}, +"adSharingError": { +"description": "The reasons for the ad sharing error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"AD_GROUP_ALREADY_CONTAINS_AD", +"INCOMPATIBLE_AD_UNDER_AD_GROUP", +"CANNOT_SHARE_INACTIVE_AD" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Error resulting in attempting to add an Ad to an AdGroup that already contains the Ad.", +"Ad is not compatible with the AdGroup it is being shared with.", +"Cannot add AdGroupAd on inactive Ad." +], +"type": "string" +}, +"adxError": { +"description": "The reasons for the adx error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"UNSUPPORTED_FEATURE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Attempt to use non-AdX feature by AdX customer." +], +"type": "string" +}, +"assetError": { +"description": "The reasons for the asset error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CUSTOMER_NOT_ON_ALLOWLIST_FOR_ASSET_TYPE", +"DUPLICATE_ASSET", +"DUPLICATE_ASSET_NAME", +"ASSET_DATA_IS_MISSING", +"CANNOT_MODIFY_ASSET_NAME", +"FIELD_INCOMPATIBLE_WITH_ASSET_TYPE", +"INVALID_CALL_TO_ACTION_TEXT", +"LEAD_FORM_INVALID_FIELDS_COMBINATION", +"LEAD_FORM_MISSING_AGREEMENT", +"INVALID_ASSET_STATUS", +"FIELD_CANNOT_BE_MODIFIED_FOR_ASSET_TYPE", +"SCHEDULES_CANNOT_OVERLAP", +"PROMOTION_CANNOT_SET_PERCENT_OFF_AND_MONEY_AMOUNT_OFF", +"PROMOTION_CANNOT_SET_PROMOTION_CODE_AND_ORDERS_OVER_AMOUNT", +"TOO_MANY_DECIMAL_PLACES_SPECIFIED", +"DUPLICATE_ASSETS_WITH_DIFFERENT_FIELD_VALUE", +"CALL_CARRIER_SPECIFIC_SHORT_NUMBER_NOT_ALLOWED", +"CALL_CUSTOMER_CONSENT_FOR_CALL_RECORDING_REQUIRED", +"CALL_DISALLOWED_NUMBER_TYPE", +"CALL_INVALID_CONVERSION_ACTION", +"CALL_INVALID_COUNTRY_CODE", +"CALL_INVALID_DOMESTIC_PHONE_NUMBER_FORMAT", +"CALL_INVALID_PHONE_NUMBER", +"CALL_PHONE_NUMBER_NOT_SUPPORTED_FOR_COUNTRY", +"CALL_PREMIUM_RATE_NUMBER_NOT_ALLOWED", +"CALL_VANITY_PHONE_NUMBER_NOT_ALLOWED", +"PRICE_HEADER_SAME_AS_DESCRIPTION", +"MOBILE_APP_INVALID_APP_ID", +"MOBILE_APP_INVALID_FINAL_URL_FOR_APP_DOWNLOAD_URL", +"NAME_REQUIRED_FOR_ASSET_TYPE", +"LEAD_FORM_LEGACY_QUALIFYING_QUESTIONS_DISALLOWED", +"NAME_CONFLICT_FOR_ASSET_TYPE", +"CANNOT_MODIFY_ASSET_SOURCE", +"CANNOT_MODIFY_AUTOMATICALLY_CREATED_ASSET", +"LEAD_FORM_LOCATION_ANSWER_TYPE_DISALLOWED", +"PAGE_FEED_INVALID_LABEL_TEXT", +"CUSTOMER_NOT_ON_ALLOWLIST_FOR_WHATSAPP_MESSAGE_ASSETS", +"CUSTOMER_NOT_ON_ALLOWLIST_FOR_APP_DEEP_LINK_ASSETS", +"PROMOTION_BARCODE_CANNOT_CONTAIN_LINKS", +"PROMOTION_BARCODE_INVALID_FORMAT", +"UNSUPPORTED_BARCODE_TYPE", +"PROMOTION_QR_CODE_CANNOT_CONTAIN_LINKS", +"PROMOTION_QR_CODE_INVALID_FORMAT", +"CUSTOMER_NOT_ON_ALLOWLIST_FOR_MESSAGE_ASSETS" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The customer is not on the allow-list for this asset type.", +"Assets are duplicated across operations.", +"The asset name is duplicated, either across operations or with an existing asset.", +"The `Asset.asset_data` oneof is empty.", +"The asset has a name which is different from an existing duplicate that represents the same content.", +"The field cannot be set for this asset type.", +"Call to action must come from the list of supported values.", +"A lead form asset is created with an invalid combination of input fields.", +"Lead forms require that the Terms of Service have been agreed to before mutates can be executed.", +"Asset status is invalid in this operation.", +"The field cannot be modified by this asset type.", +"Ad schedules for the same asset cannot overlap.", +"Cannot set both percent off and money amount off fields of promotion asset.", +"Cannot set both promotion code and orders over amount fields of promotion asset.", +"The field has too many decimal places specified.", +"Duplicate assets across operations, which have identical `Asset.asset_data` oneof, cannot have different asset level fields for asset types which are deduped.", +"Carrier-specific short number is not allowed.", +"Customer consent required for call recording Terms of Service.", +"The type of the specified phone number is not allowed.", +"If the default `call_conversion_action` is not used, the customer must have a `ConversionAction` with the same id and the `ConversionAction` must be call conversion type.", +"The country code of the phone number is invalid.", +"The format of the phone number is incorrect.", +"The input phone number is not a valid phone number.", +"The phone number is not supported for this country.", +"Premium rate phone number is not allowed.", +"Vanity phone number is not allowed.", +"`PriceOffering` cannot have the same value for header and description.", +"`AppId` is invalid.", +"Invalid App download URL in final URLs.", +"Asset name is required for the asset type.", +"Legacy qualifying questions cannot be in the same Lead Form as custom questions.", +"Unique name is required for this asset type.", +"Cannot modify asset source.", +"User can not modify the automatically created asset.", +"Lead Form is disallowed to use `LOCATION` answer type.", +"Page Feed label text contains invalid characters.", +"The customer is not in the allow-list for whatsapp message asset type.", +"Only customers on the allowlist can create `AppDeepLinkAsset`.", +"Promotion barcode cannot contain links.", +"Failed to encode promotion barcode: Invalid format.", +"Barcode type is not supported.", +"Promotion QR code cannot contain links.", +"Failed to encode promotion QR code: Invalid format.", +"The customer is not in the allow-list for Business message asset type." +], +"type": "string" +}, +"assetGenerationError": { +"description": "The reasons for the GenAI asset generation error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"NO_ASSETS_GENERATED", +"FINAL_URL_REQUIRED", +"GENERATION_CONTEXT_MISSING_FINAL_URL", +"FINAL_URL_SENSITIVE", +"FINAL_URL_UNSUPPORTED_LANGUAGE", +"FINAL_URL_UNAVAILABLE", +"CAMPAIGN_TYPE_REQUIRED", +"UNSUPPORTED_CAMPAIGN_TYPE", +"UNSUPPORTED_FIELD_TYPE", +"UNSUPPORTED_FIELD_TYPE_FOR_CAMPAIGN_TYPE", +"FREEFORM_PROMPT_UNSUPPORTED_LANGUAGE", +"FREEFORM_PROMPT_SENSITIVE", +"INPUT_IMAGE_FILE_SIZE_TOO_LARGE", +"INPUT_IMAGE_EMPTY", +"GENERATION_TYPE_REQUIRED", +"TOO_MANY_KEYWORDS", +"KEYWORD_INVALID_LENGTH", +"NO_VALID_KEYWORDS", +"FREEFORM_PROMPT_INVALID_LENGTH", +"FREEFORM_PROMPT_REFERENCES_CHILDREN", +"FREEFORM_PROMPT_REFERENCES_SPECIFIC_PEOPLE", +"FREEFORM_PROMPT_VIOLATES_ADS_POLICY", +"FREEFORM_PROMPT_BRAND_CONTENT", +"INPUT_IMAGE_DEPICTS_CHILDREN", +"INPUT_IMAGE_CONTAINS_BRAND_CONTENT", +"INPUT_IMAGE_SENSITIVE", +"INPUT_IMAGE_VIOLATES_POLICY", +"ALL_OUTPUT_IMAGES_FILTERED_OUT_CHILDREN_DEPICTION", +"ALL_OUTPUT_IMAGES_FILTERED_OUT_SPECIFIC_PEOPLE", +"ALL_OUTPUT_IMAGES_FILTERED_OUT", +"INPUT_IMAGE_REQUIRED", +"INPUT_IMAGE_UNSUPPORTED_IMAGE_TYPE", +"CONTEXT_ASSET_GROUP_NOT_FOUND", +"CONTEXT_AD_GROUP_AD_NOT_FOUND", +"CONTEXT_CAMPAIGN_NOT_FOUND" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"No assets were generated for the given request.", +"A final URL is required but was not provided, and could not be sourced from the existing generation context because no existing generation context was provided.", +"A final URL is required but was not provided, and could not be sourced from the provided existing generation context.", +"The provided final URL is considered sensitive, and assets cannot be generated.", +"The language of the provided final URL is not supported.", +"The provided final URL was not indexed or could otherwise not be processed.", +"Campaign type is required but was not provided, and could not be sourced from the existing generation context because no existing generation context was provided.", +"The provided campaign type is not supported for this asset generation operation.", +"The provided field type is not supported for this asset generation operation.", +"The provided field type is not supported for the given campaign type.", +"The language of the provided freeform prompt is not supported.", +"The provided freeform prompt is considered sensitive, and assets cannot be generated.", +"The provided image file size exceeds the limit.", +"The provided image is empty.", +"Exactly one generation type must be provided.", +"Too many keywords provided in request.", +"A provided keyword does not have a valid length.", +"All keywords were filtered out.", +"The provided freeform prompt does not have a valid length.", +"The provided freeform prompt references children.", +"The provided freeform prompt references specific people.", +"The provided freeform prompt violates Ads Policy.", +"The provided freeform prompt contains brand content.", +"The provided image depicts children.", +"The provided image contains brand content.", +"The provided image contains sensitive subject matter.", +"The provided image may violate Google Ads policies.", +"All output images were filtered out because they included depictions of children.", +"All output images were filtered out because they included depictions of specific people.", +"All output images were filtered out for a reason not covered by a more specific error code.", +"At least one input image is required for certain requests.", +"The provided image is of an unsupported type.", +"Asset Group could not be found with the provided ID.", +"Ad Group Ad could not be found with the provided ID combination.", +"Could not find Campaign associated with the provided generation context." +], +"type": "string" +}, +"assetGroupAssetError": { +"description": "The reasons for the asset group asset error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"DUPLICATE_RESOURCE", +"EXPANDABLE_TAGS_NOT_ALLOWED_IN_DESCRIPTION", +"AD_CUSTOMIZER_NOT_SUPPORTED", +"HOTEL_PROPERTY_ASSET_NOT_LINKED_TO_CAMPAIGN" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Cannot add duplicated asset group asset.", +"Expandable tags are not allowed in description assets.", +"Ad customizers are not supported in assetgroup's text assets.", +"Cannot add a HotelPropertyAsset to an AssetGroup that isn't linked to the parent campaign's hotel_property_asset_set field." +], +"type": "string" +}, +"assetGroupError": { +"description": "The reasons for the asset group error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"DUPLICATE_NAME", +"CANNOT_ADD_ASSET_GROUP_FOR_CAMPAIGN_TYPE", +"NOT_ENOUGH_HEADLINE_ASSET", +"NOT_ENOUGH_LONG_HEADLINE_ASSET", +"NOT_ENOUGH_DESCRIPTION_ASSET", +"NOT_ENOUGH_BUSINESS_NAME_ASSET", +"NOT_ENOUGH_MARKETING_IMAGE_ASSET", +"NOT_ENOUGH_SQUARE_MARKETING_IMAGE_ASSET", +"NOT_ENOUGH_LOGO_ASSET", +"FINAL_URL_SHOPPING_MERCHANT_HOME_PAGE_URL_DOMAINS_DIFFER", +"PATH1_REQUIRED_WHEN_PATH2_IS_SET", +"SHORT_DESCRIPTION_REQUIRED", +"FINAL_URL_REQUIRED", +"FINAL_URL_CONTAINS_INVALID_DOMAIN_NAME", +"AD_CUSTOMIZER_NOT_SUPPORTED", +"CANNOT_MUTATE_ASSET_GROUP_FOR_REMOVED_CAMPAIGN" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Each asset group in a single campaign must have a unique name.", +"Cannot add asset group for the campaign type.", +"Not enough headline asset for a valid asset group.", +"Not enough long headline asset for a valid asset group.", +"Not enough description headline asset for a valid asset group.", +"Not enough business name asset for a valid asset group.", +"Not enough marketing image asset for a valid asset group.", +"Not enough square marketing image asset for a valid asset group.", +"Not enough logo asset for a valid asset group.", +"Final url and shopping merchant url does not have the same domain.", +"Path1 required when path2 is set.", +"At least one short description asset is required for a valid asset group.", +"Final url field is required for asset group.", +"Final url contains invalid domain name.", +"Ad customizers are not supported in asset group's text field.", +"Cannot mutate asset group for campaign with removed status." +], +"type": "string" +}, +"assetGroupListingGroupFilterError": { +"description": "The reasons for the asset group listing group filter error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"TREE_TOO_DEEP", +"UNIT_CANNOT_HAVE_CHILDREN", +"SUBDIVISION_MUST_HAVE_EVERYTHING_ELSE_CHILD", +"DIFFERENT_DIMENSION_TYPE_BETWEEN_SIBLINGS", +"SAME_DIMENSION_VALUE_BETWEEN_SIBLINGS", +"SAME_DIMENSION_TYPE_BETWEEN_ANCESTORS", +"MULTIPLE_ROOTS", +"INVALID_DIMENSION_VALUE", +"MUST_REFINE_HIERARCHICAL_PARENT_TYPE", +"INVALID_PRODUCT_BIDDING_CATEGORY", +"CHANGING_CASE_VALUE_WITH_CHILDREN", +"SUBDIVISION_HAS_CHILDREN", +"CANNOT_REFINE_HIERARCHICAL_EVERYTHING_ELSE", +"DIMENSION_TYPE_NOT_ALLOWED", +"DUPLICATE_WEBPAGE_FILTER_UNDER_ASSET_GROUP", +"LISTING_SOURCE_NOT_ALLOWED", +"FILTER_EXCLUSION_NOT_ALLOWED", +"MULTIPLE_LISTING_SOURCES", +"MULTIPLE_WEBPAGE_CONDITION_TYPES_NOT_ALLOWED", +"MULTIPLE_WEBPAGE_TYPES_PER_ASSET_GROUP", +"PAGE_FEED_FILTER_HAS_PARENT", +"MULTIPLE_OPERATIONS_ON_ONE_NODE", +"TREE_WAS_INVALID_BEFORE_MUTATION" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Listing group tree is too deep.", +"Listing Group UNIT node cannot have children.", +"Listing Group SUBDIVISION node must have everything else child.", +"Dimension type of Listing Group must be the same as that of its siblings.", +"The sibling Listing Groups target exactly the same dimension value.", +"The dimension type is the same as one of the ancestor Listing Groups.", +"Each Listing Group tree must have a single root.", +"Invalid Listing Group dimension value.", +"Hierarchical dimension must refine a dimension of the same type.", +"Invalid Product Bidding Category.", +"Modifying case value is allowed only while updating the entire subtree at the same time.", +"Subdivision node has children which must be removed first.", +"Dimension can't subdivide everything-else node in its own hierarchy.", +"This dimension type is not allowed in this context.", +"All the webpage filters under an AssetGroup should be distinct.", +"Filter of the listing source type is not allowed in the context.", +"Exclusion filters are not allowed in the context.", +"All the filters under an AssetGroup should have the same listing source.", +"All the conditions in a webpage needs to be of same type.", +"All the webpage types of the filters under an AssetGroup should be of same type. Example: All the webpage types can be of type custom_label or url_contains but not both.", +"All page feed filter nodes are root nodes and they can't have a parent.", +"There cannot be more than one mutate operation per request that targets a single asset group listing group filter.", +"The tree is in an invalid state in the database. Any changes that don't fix its issues will fail validation." +], +"type": "string" +}, +"assetGroupSignalError": { +"description": "The reasons for the asset group hint error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"TOO_MANY_WORDS", +"SEARCH_THEME_POLICY_VIOLATION", +"AUDIENCE_WITH_WRONG_ASSET_GROUP_ID" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The number of words in the Search Theme signal exceed the allowed maximum. You can add up to 10 words in a keyword. See https://support.google.com/google-ads/answer/7476658 for details.", +"The search theme requested to be added violates certain policy. See https://support.google.com/adspolicy/answer/6008942.", +"The asset group referenced by the asset group signal does not match the asset group referenced by the audience being used in the asset group signal." +], +"type": "string" +}, +"assetLinkError": { +"description": "The reasons for the asset link error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"PINNING_UNSUPPORTED", +"UNSUPPORTED_FIELD_TYPE", +"FIELD_TYPE_INCOMPATIBLE_WITH_ASSET_TYPE", +"FIELD_TYPE_INCOMPATIBLE_WITH_CAMPAIGN_TYPE", +"INCOMPATIBLE_ADVERTISING_CHANNEL_TYPE", +"IMAGE_NOT_WITHIN_SPECIFIED_DIMENSION_RANGE", +"INVALID_PINNED_FIELD", +"MEDIA_BUNDLE_ASSET_FILE_SIZE_TOO_LARGE", +"NOT_ENOUGH_AVAILABLE_ASSET_LINKS_FOR_VALID_COMBINATION", +"NOT_ENOUGH_AVAILABLE_ASSET_LINKS_WITH_FALLBACK", +"NOT_ENOUGH_AVAILABLE_ASSET_LINKS_WITH_FALLBACK_FOR_VALID_COMBINATION", +"YOUTUBE_VIDEO_REMOVED", +"YOUTUBE_VIDEO_TOO_LONG", +"YOUTUBE_VIDEO_TOO_SHORT", +"EXCLUDED_PARENT_FIELD_TYPE", +"INVALID_STATUS", +"YOUTUBE_VIDEO_DURATION_NOT_DEFINED", +"CANNOT_CREATE_AUTOMATICALLY_CREATED_LINKS", +"CANNOT_LINK_TO_AUTOMATICALLY_CREATED_ASSET", +"CANNOT_MODIFY_ASSET_LINK_SOURCE", +"CANNOT_LINK_LOCATION_LEAD_FORM_WITHOUT_LOCATION_ASSET", +"CUSTOMER_NOT_VERIFIED", +"UNSUPPORTED_CALL_TO_ACTION", +"BRAND_ASSETS_NOT_LINKED_AT_ASSET_GROUP_LEVEL", +"BRAND_ASSETS_NOT_LINKED_AT_CAMPAIGN_LEVEL" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Pinning is not supported for the given asset link field.", +"The given field type is not supported to be added directly through asset links.", +"The given asset's type and the specified field type are incompatible.", +"The specified field type is incompatible with the given campaign type.", +"The campaign advertising channel type cannot be associated with the given asset due to channel-based restrictions on the asset's fields.", +"The image asset provided is not within the dimension constraints specified for the submitted asset field.", +"The pinned field is not valid for the submitted asset field.", +"The media bundle asset provided is too large for the submitted asset field.", +"Not enough assets are available for use with other fields since other assets are pinned to specific fields.", +"Not enough assets with fallback are available. When validating the minimum number of assets, assets without fallback (for example, assets that contain location tag without default value \"{LOCATION(City)}\") will not be counted.", +"This is a combination of the NOT_ENOUGH_AVAILABLE_ASSET_LINKS_FOR_VALID_COMBINATION and NOT_ENOUGH_AVAILABLE_ASSET_LINKS_WITH_FALLBACK errors. Not enough assets with fallback are available since some assets are pinned.", +"The YouTube video referenced in the provided asset has been removed.", +"The YouTube video referenced in the provided asset is too long for the field submitted.", +"The YouTube video referenced in the provided asset is too short for the field submitted.", +"The specified field type is excluded for given campaign or ad group.", +"The status is invalid for the operation specified.", +"The YouTube video referenced in the provided asset has unknown duration. This might be the case for a livestream video or a video being currently uploaded to YouTube. In both cases, the video duration should eventually get resolved.", +"User cannot create automatically created links.", +"Advertiser links cannot link to automatically created asset.", +"Automatically created links cannot be changed into advertiser links or the reverse.", +"Lead Form asset with Location answer type can't be linked to the Customer/Campaign because there are no Location assets.", +"Customer is not verified.", +"Call to action value is not supported.", +"For Performance Max campaigns where brand_guidelines_enabled is false, business name and logo assets must be linked as AssetGroupAssets.", +"For Performance Max campaigns where brand_guidelines_enabled is true, business name and logo assets must be linked as CampaignAssets." +], +"type": "string" +}, +"assetSetAssetError": { +"description": "The reasons for the asset set asset error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_ASSET_TYPE", +"INVALID_ASSET_SET_TYPE", +"DUPLICATE_EXTERNAL_KEY", +"PARENT_LINKAGE_DOES_NOT_EXIST" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The asset type is not eligible to be linked to the specific type of asset set.", +"The asset set type is not eligible to contain the specified type of assets.", +"The asset contains duplicate external key with another asset in the asset set.", +"When attaching a Location typed Asset to a LocationGroup typed AssetSet, the AssetSetAsset linkage between the parent LocationSync AssetSet and the Asset doesn't exist." +], +"type": "string" +}, +"assetSetError": { +"description": "The reasons for the asset set error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"DUPLICATE_ASSET_SET_NAME", +"INVALID_PARENT_ASSET_SET_TYPE", +"ASSET_SET_SOURCE_INCOMPATIBLE_WITH_PARENT_ASSET_SET", +"ASSET_SET_TYPE_CANNOT_BE_LINKED_TO_CUSTOMER", +"INVALID_CHAIN_IDS", +"LOCATION_SYNC_ASSET_SET_DOES_NOT_SUPPORT_RELATIONSHIP_TYPE", +"NOT_UNIQUE_ENABLED_LOCATION_SYNC_TYPED_ASSET_SET", +"INVALID_PLACE_IDS", +"OAUTH_INFO_INVALID", +"OAUTH_INFO_MISSING", +"CANNOT_DELETE_AS_ENABLED_LINKAGES_EXIST" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The asset set name matches that of another enabled asset set.", +"The type of AssetSet.asset_set_source does not match the type of AssetSet.location_set.source in its parent AssetSet.", +"The asset set source doesn't match its parent AssetSet's data.", +"This AssetSet type cannot be linked to CustomerAssetSet.", +"The chain id(s) in ChainSet of a LOCATION_SYNC typed AssetSet is invalid.", +"The relationship type in ChainSet of a LOCATION_SYNC typed AssetSet is not supported.", +"There is more than one enabled LocationSync typed AssetSet under one customer.", +"The place id(s) in a LocationSync typed AssetSet is invalid and can't be decoded.", +"The Google Business Profile OAuth info is invalid.", +"The Google Business Profile OAuth info is missing.", +"Can't delete an AssetSet if it has any enabled linkages (e.g. CustomerAssetSet), or AssetSet is a parent AssetSet and has enabled child AssetSet associated." +], +"type": "string" +}, +"assetSetLinkError": { +"description": "The reasons for the asset set link error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INCOMPATIBLE_ADVERTISING_CHANNEL_TYPE", +"DUPLICATE_FEED_LINK", +"INCOMPATIBLE_ASSET_SET_TYPE_WITH_CAMPAIGN_TYPE", +"DUPLICATE_ASSET_SET_LINK", +"ASSET_SET_LINK_CANNOT_BE_REMOVED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Advertising channel type cannot be attached to the asset set due to channel-based restrictions.", +"For this asset set type, only one campaign to feed linkage is allowed.", +"The asset set type and campaign type are incompatible.", +"Cannot link duplicate asset sets to the same campaign.", +"Cannot remove the asset set link. If a campaign is linked with only one asset set and you attempt to unlink them, this error will be triggered." +], +"type": "string" +}, +"audienceError": { +"description": "The reasons for the audience error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"NAME_ALREADY_IN_USE", +"DIMENSION_INVALID", +"AUDIENCE_SEGMENT_NOT_FOUND", +"AUDIENCE_SEGMENT_TYPE_NOT_SUPPORTED", +"DUPLICATE_AUDIENCE_SEGMENT", +"TOO_MANY_SEGMENTS", +"TOO_MANY_DIMENSIONS_OF_SAME_TYPE", +"IN_USE", +"MISSING_ASSET_GROUP_ID", +"CANNOT_CHANGE_FROM_CUSTOMER_TO_ASSET_GROUP_SCOPE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"An audience with this name already exists.", +"A dimension within the audience definition is not valid.", +"One of the audience segment added is not found.", +"One of the audience segment type is not supported.", +"The same segment already exists in this audience.", +"Audience can't have more than allowed number segments.", +"Audience can't have multiple dimensions of same type.", +"The audience cannot be removed, because it is currently used in an ad group criterion or asset group signal in an (enabled or paused) ad group or campaign.", +"Asset Group scoped audience requires an asset group ID.", +"Audience scope may not be changed from Customer to AssetGroup." +], +"type": "string" +}, +"audienceInsightsError": { +"description": "The reasons for the Audience Insights error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"DIMENSION_INCOMPATIBLE_WITH_TOPIC_AUDIENCE_COMBINATIONS" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The dimensions cannot be used with topic audience combinations." +], +"type": "string" +}, +"authenticationError": { +"description": "Indicates failure to properly authenticate user.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"AUTHENTICATION_ERROR", +"CLIENT_CUSTOMER_ID_INVALID", +"CUSTOMER_NOT_FOUND", +"GOOGLE_ACCOUNT_DELETED", +"GOOGLE_ACCOUNT_COOKIE_INVALID", +"GOOGLE_ACCOUNT_AUTHENTICATION_FAILED", +"GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH", +"LOGIN_COOKIE_REQUIRED", +"NOT_ADS_USER", +"OAUTH_TOKEN_INVALID", +"OAUTH_TOKEN_EXPIRED", +"OAUTH_TOKEN_DISABLED", +"OAUTH_TOKEN_REVOKED", +"OAUTH_TOKEN_HEADER_INVALID", +"LOGIN_COOKIE_INVALID", +"INVALID_EMAIL_ADDRESS", +"USER_ID_INVALID", +"TWO_STEP_VERIFICATION_NOT_ENROLLED", +"ADVANCED_PROTECTION_NOT_ENROLLED", +"ORGANIZATION_NOT_RECOGNIZED", +"ORGANIZATION_NOT_APPROVED", +"ORGANIZATION_NOT_ASSOCIATED_WITH_DEVELOPER_TOKEN", +"DEVELOPER_TOKEN_INVALID" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Authentication of the request failed.", +"Client customer ID is not a number.", +"No customer found for the provided customer ID.", +"Client's Google account is deleted.", +"Account login token in the cookie is invalid.", +"A problem occurred during Google account authentication.", +"The user in the Google account login token does not match the user ID in the cookie.", +"Login cookie is required for authentication.", +"The Google account that generated the OAuth access token is not associated with a Search Ads 360 account. Create a new account, or add the Google account to an existing Search Ads 360 account.", +"OAuth token in the header is not valid.", +"OAuth token in the header has expired.", +"OAuth token in the header has been disabled.", +"OAuth token in the header has been revoked.", +"OAuth token HTTP header is malformed.", +"Login cookie is not valid.", +"The email address provided is invalid or does not exist.", +"User ID in the header is not a valid ID.", +"An account administrator changed this account's authentication settings. To access this account, enable 2-Step Verification in your Google account at https://www.google.com/landing/2step.", +"An account administrator changed this account's authentication settings. To access this account, enable Advanced Protection in your Google account at https://landing.google.com/advancedprotection.", +"The Cloud organization associated with the project is not recognized.", +"The Cloud organization associated with the project is not approved for prod access.", +"The Cloud organization associated with the project is not associated with the developer token.", +"The developer token is not valid." +], +"type": "string" +}, +"authorizationError": { +"description": "An error encountered when trying to authorize a user.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"USER_PERMISSION_DENIED", +"DEVELOPER_TOKEN_NOT_ON_ALLOWLIST", +"DEVELOPER_TOKEN_PROHIBITED", +"PROJECT_DISABLED", +"AUTHORIZATION_ERROR", +"ACTION_NOT_PERMITTED", +"INCOMPLETE_SIGNUP", +"CUSTOMER_NOT_ENABLED", +"MISSING_TOS", +"DEVELOPER_TOKEN_NOT_APPROVED", +"INVALID_LOGIN_CUSTOMER_ID_SERVING_CUSTOMER_ID_COMBINATION", +"SERVICE_ACCESS_DENIED", +"ACCESS_DENIED_FOR_ACCOUNT_TYPE", +"METRIC_ACCESS_DENIED", +"CLOUD_PROJECT_NOT_UNDER_ORGANIZATION", +"ACTION_NOT_PERMITTED_FOR_SUSPENDED_ACCOUNT" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"User doesn't have permission to access customer. Note: If you're accessing a client customer, the manager's customer ID must be set in the `login-customer-id` header. Learn more at https://developers.google.com/search-ads/reporting/concepts/call-structure#login_customer_id_header", +"The developer token is not on the allow-list.", +"The developer token is not allowed with the project sent in the request.", +"The Google Cloud project sent in the request does not have permission to access the api.", +"Authorization of the client failed.", +"The user does not have permission to perform this action (for example, ADD, UPDATE, REMOVE) on the resource or call a method.", +"Signup not complete.", +"The customer account can't be accessed because it is not yet enabled or has been deactivated.", +"The developer must sign the terms of service. They can be found here: https://developers.google.com/terms", +"The developer token is only approved for use with test accounts. To access non-test accounts, apply for Basic or Standard access.", +"The login customer specified does not have access to the account specified, so the request is invalid.", +"The developer specified does not have access to the service.", +"The customer (or login customer) isn't allowed in Search Ads 360 API. It belongs to another ads system.", +"The developer does not have access to the metrics queried.", +"The Google Cloud project is not under the required organization.", +"The user does not have permission to perform this action on the resource or method because the Google Ads account is suspended." +], +"type": "string" +}, +"automaticallyCreatedAssetRemovalError": { +"description": "The reasons for error in automatically created asset removal action.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"AD_DOES_NOT_EXIST", +"INVALID_AD_TYPE", +"ASSET_DOES_NOT_EXIST", +"ASSET_FIELD_TYPE_DOES_NOT_MATCH", +"NOT_AN_AUTOMATICALLY_CREATED_ASSET" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The ad does not exist.", +"Ad type is not supported. Only Responsive Search Ad type is supported.", +"The asset does not exist.", +"The asset field type does not match.", +"Not an automatically created asset." +], +"type": "string" +}, +"batchJobError": { +"description": "The reasons for the batch job error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CANNOT_MODIFY_JOB_AFTER_JOB_STARTS_RUNNING", +"EMPTY_OPERATIONS", +"INVALID_SEQUENCE_TOKEN", +"RESULTS_NOT_READY", +"INVALID_PAGE_SIZE", +"CAN_ONLY_REMOVE_PENDING_JOB", +"CANNOT_LIST_RESULTS", +"ASSET_GROUP_AND_ASSET_GROUP_ASSET_TRANSACTION_FAILURE", +"ASSET_GROUP_LISTING_GROUP_FILTER_TRANSACTION_FAILURE", +"REQUEST_TOO_LARGE", +"CAMPAIGN_AND_CAMPAIGN_ASSET_TRANSACTION_FAILURE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The batch job cannot add more operations or run after it has started running.", +"The operations for an AddBatchJobOperations request were empty.", +"The sequence token for an AddBatchJobOperations request was invalid.", +"Batch job results can only be retrieved once the job is finished.", +"The page size for ListBatchJobResults was invalid.", +"The batch job cannot be removed because it has started running.", +"The batch job cannot be listed due to unexpected errors such as duplicate checkpoints.", +"The request contains interdependent AssetGroup and AssetGroupAsset operations that are treated atomically as a single transaction, and one or more of the operations in that transaction failed, which caused the entire transaction, and therefore this mutate operation, to fail. The operations that caused the transaction to fail can be found in the consecutive AssetGroup or AssetGroupAsset results with the same asset group id. The mutate operation will be successful once the remaining errors in the transaction are fixed.", +"The request contains interdependent AssetGroupListingGroupFilter operations that are treated atomically as a single transaction, and one or more of the operations in that transaction failed, which caused the entire transaction, and therefore this mutate operation, to fail. The operations that caused the transaction to fail can be found in the consecutive AssetGroupListingGroupFilter results with the same asset group id. The mutate operation will be successful once the remaining errors in the transaction are fixed.", +"The AddBatchJobOperationsRequest is too large. Split the request into smaller requests. The maximum allowed request size is 10484504 bytes.", +"This error indicates a failed transaction involving interdependent Campaign and CampaignAsset operations that are treated atomically as a single transaction. Because some operations within the transaction failed, the entire set of changes was rejected. Related error details are found in the results for the Campaign and CampaignAssets sharing the same Campaign ID. The transaction will succeed after all associated errors are resolved." +], +"type": "string" +}, +"benchmarksError": { +"description": "The reasons for the Benchmarks error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"MAX_QUERY_COMPLEXITY_EXCEEDED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The combination of inputs to generate benchmarks is too complex. To reduce complexity, try selecting a more granular benchmarks source, a smaller date range, or a smaller set of products." +], +"type": "string" +}, +"biddingError": { +"description": "The reasons for the bidding errors", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"BIDDING_STRATEGY_TRANSITION_NOT_ALLOWED", +"CANNOT_ATTACH_BIDDING_STRATEGY_TO_CAMPAIGN", +"INVALID_ANONYMOUS_BIDDING_STRATEGY_TYPE", +"INVALID_BIDDING_STRATEGY_TYPE", +"INVALID_BID", +"BIDDING_STRATEGY_NOT_AVAILABLE_FOR_ACCOUNT_TYPE", +"CANNOT_CREATE_CAMPAIGN_WITH_BIDDING_STRATEGY", +"CANNOT_TARGET_CONTENT_NETWORK_ONLY_WITH_CAMPAIGN_LEVEL_POP_BIDDING_STRATEGY", +"BIDDING_STRATEGY_NOT_SUPPORTED_WITH_AD_SCHEDULE", +"PAY_PER_CONVERSION_NOT_AVAILABLE_FOR_CUSTOMER", +"PAY_PER_CONVERSION_NOT_ALLOWED_WITH_TARGET_CPA", +"BIDDING_STRATEGY_NOT_ALLOWED_FOR_SEARCH_ONLY_CAMPAIGNS", +"BIDDING_STRATEGY_NOT_SUPPORTED_IN_DRAFTS_OR_EXPERIMENTS", +"BIDDING_STRATEGY_TYPE_DOES_NOT_SUPPORT_PRODUCT_TYPE_ADGROUP_CRITERION", +"BID_TOO_SMALL", +"BID_TOO_BIG", +"BID_TOO_MANY_FRACTIONAL_DIGITS", +"INVALID_DOMAIN_NAME", +"NOT_COMPATIBLE_WITH_PAYMENT_MODE", +"BIDDING_STRATEGY_TYPE_INCOMPATIBLE_WITH_SHARED_BUDGET", +"BIDDING_STRATEGY_AND_BUDGET_MUST_BE_ALIGNED", +"BIDDING_STRATEGY_AND_BUDGET_MUST_BE_ATTACHED_TO_THE_SAME_CAMPAIGNS_TO_ALIGN", +"BIDDING_STRATEGY_AND_BUDGET_MUST_BE_REMOVED_TOGETHER", +"CPC_BID_FLOOR_MICROS_GREATER_THAN_CPC_BID_CEILING_MICROS", +"TARGET_ROAS_TOLERANCE_PERCENT_MILLIS_MUST_BE_INTEGER" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Cannot transition to new bidding strategy.", +"Cannot attach bidding strategy to campaign.", +"Bidding strategy is not supported or cannot be used as anonymous.", +"The type does not match the named strategy's type.", +"The bid is invalid.", +"Bidding strategy is not available for the account type.", +"Campaign can not be created with given bidding strategy. It can be transitioned to the strategy, once eligible.", +"Cannot target content network only as campaign uses Page One Promoted bidding strategy.", +"Budget Optimizer and Target Spend bidding strategies are not supported for campaigns with AdSchedule targeting.", +"Pay per conversion is not available to all the customer, only few customers on the allow-list can use this.", +"Pay per conversion is not allowed with Target CPA.", +"Cannot set bidding strategy to Manual CPM for search network only campaigns.", +"The bidding strategy is not supported for use in drafts or experiments.", +"Bidding strategy type does not support product type ad group criterion.", +"Bid amount is too small.", +"Bid amount is too big.", +"Bid has too many fractional digit precision.", +"Invalid domain name specified.", +"The field is not compatible with the payment mode.", +"Bidding strategy type is incompatible with shared budget.", +"The attached bidding strategy and budget must be aligned with each other if alignment is specified on either entity.", +"The attached bidding strategy and budget must be attached to the same campaigns to become aligned.", +"The aligned bidding strategy and budget must be removed at the same time.", +"cpc_bid_floor_micros is greater than cpc_bid_ceiling_micros.", +"target_roas_tolerance_percent_millis must be integer." +], +"type": "string" +}, +"biddingStrategyError": { +"description": "An error with a Bidding Strategy mutate.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"DUPLICATE_NAME", +"CANNOT_CHANGE_BIDDING_STRATEGY_TYPE", +"CANNOT_REMOVE_ASSOCIATED_STRATEGY", +"BIDDING_STRATEGY_NOT_SUPPORTED", +"INCOMPATIBLE_BIDDING_STRATEGY_AND_BIDDING_STRATEGY_GOAL_TYPE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Each bidding strategy must have a unique name.", +"Bidding strategy type is immutable.", +"Only bidding strategies not linked to campaigns, adgroups or adgroup criteria can be removed.", +"The specified bidding strategy is not supported.", +"The bidding strategy is incompatible with the campaign's bidding strategy goal type." +], +"type": "string" +}, +"billingSetupError": { +"description": "The reasons for the billing setup error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CANNOT_USE_EXISTING_AND_NEW_ACCOUNT", +"CANNOT_REMOVE_STARTED_BILLING_SETUP", +"CANNOT_CHANGE_BILLING_TO_SAME_PAYMENTS_ACCOUNT", +"BILLING_SETUP_NOT_PERMITTED_FOR_CUSTOMER_STATUS", +"INVALID_PAYMENTS_ACCOUNT", +"BILLING_SETUP_NOT_PERMITTED_FOR_CUSTOMER_CATEGORY", +"INVALID_START_TIME_TYPE", +"THIRD_PARTY_ALREADY_HAS_BILLING", +"BILLING_SETUP_IN_PROGRESS", +"NO_SIGNUP_PERMISSION", +"CHANGE_OF_BILL_TO_IN_PROGRESS", +"PAYMENTS_PROFILE_NOT_FOUND", +"PAYMENTS_ACCOUNT_NOT_FOUND", +"PAYMENTS_PROFILE_INELIGIBLE", +"PAYMENTS_ACCOUNT_INELIGIBLE", +"CUSTOMER_NEEDS_INTERNAL_APPROVAL", +"PAYMENTS_PROFILE_NEEDS_SERVICE_AGREEMENT_ACCEPTANCE", +"PAYMENTS_ACCOUNT_INELIGIBLE_CURRENCY_CODE_MISMATCH", +"FUTURE_START_TIME_PROHIBITED", +"TOO_MANY_BILLING_SETUPS_FOR_PAYMENTS_ACCOUNT" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Cannot specify both an existing payments account and a new payments account when setting up billing.", +"Cannot cancel an approved billing setup whose start time has passed.", +"Cannot perform a Change of Bill-To (CBT) to the same payments account.", +"Billing setups can only be used by customers with ENABLED or DRAFT status.", +"Billing setups must either include a correctly formatted existing payments account id, or a non-empty new payments account name.", +"Only billable and third-party customers can create billing setups.", +"Billing setup creations can only use NOW for start time type.", +"Billing setups can only be created for a third-party customer if they do not already have a setup.", +"Billing setups cannot be created if there is already a pending billing in progress.", +"Billing setups can only be created by customers who have permission to setup billings. Users can contact a representative for help setting up permissions.", +"Billing setups cannot be created if there is already a future-approved billing.", +"Requested payments profile not found.", +"Requested payments account not found.", +"Billing setup creation failed because the payments profile is ineligible.", +"Billing setup creation failed because the payments account is ineligible.", +"Billing setup creation failed because the payments profile needs internal approval.", +"Billing setup creation failed because the user needs to accept master service agreement on the payments profile.", +"Payments account has different currency code than the current customer and hence cannot be used to setup billing.", +"A start time in the future cannot be used because there is currently no active billing setup for this customer.", +"The payments account has maximum number of billing setups." +], +"type": "string" +}, +"brandGuidelinesMigrationError": { +"description": "The reasons for the brand guidelines migration error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"BRAND_GUIDELINES_ALREADY_ENABLED", +"CANNOT_ENABLE_BRAND_GUIDELINES_FOR_REMOVED_CAMPAIGN", +"BRAND_GUIDELINES_LOGO_LIMIT_EXCEEDED", +"CANNOT_AUTO_POPULATE_BRAND_ASSETS_WHEN_BRAND_ASSETS_PROVIDED", +"AUTO_POPULATE_BRAND_ASSETS_REQUIRED_WHEN_BRAND_ASSETS_OMITTED", +"TOO_MANY_ENABLE_OPERATIONS" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"This campaign is already enabled for Brand Guidelines.", +"Brand Guidelines can only be enabled for active or suspended campaigns.", +"Maximum of 5 square and landscape logos can be specified for Brand Guidelines.", +"Either auto_populate_brand_assets must be true or brand_assets must be provided, but not both.", +"Either auto_populate_brand_assets can be false or brand_assets can be omitted, but not both.", +"A maximum of 10 enable operations can be executed in a request." +], +"type": "string" +}, +"campaignBudgetError": { +"description": "An error with a Campaign Budget mutate.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CAMPAIGN_BUDGET_CANNOT_BE_SHARED", +"CAMPAIGN_BUDGET_REMOVED", +"CAMPAIGN_BUDGET_IN_USE", +"CAMPAIGN_BUDGET_PERIOD_NOT_AVAILABLE", +"CANNOT_MODIFY_FIELD_OF_IMPLICITLY_SHARED_CAMPAIGN_BUDGET", +"CANNOT_UPDATE_CAMPAIGN_BUDGET_TO_IMPLICITLY_SHARED", +"CANNOT_UPDATE_CAMPAIGN_BUDGET_TO_EXPLICITLY_SHARED_WITHOUT_NAME", +"CANNOT_UPDATE_CAMPAIGN_BUDGET_TO_EXPLICITLY_SHARED", +"CANNOT_USE_IMPLICITLY_SHARED_CAMPAIGN_BUDGET_WITH_MULTIPLE_CAMPAIGNS", +"DUPLICATE_NAME", +"MONEY_AMOUNT_IN_WRONG_CURRENCY", +"MONEY_AMOUNT_LESS_THAN_CURRENCY_MINIMUM_CPC", +"MONEY_AMOUNT_TOO_LARGE", +"NEGATIVE_MONEY_AMOUNT", +"NON_MULTIPLE_OF_MINIMUM_CURRENCY_UNIT", +"TOTAL_BUDGET_AMOUNT_MUST_BE_UNSET_FOR_BUDGET_PERIOD_DAILY", +"INVALID_PERIOD", +"CANNOT_USE_ACCELERATED_DELIVERY_MODE", +"BUDGET_AMOUNT_MUST_BE_UNSET_FOR_CUSTOM_BUDGET_PERIOD", +"BUDGET_BELOW_PER_DAY_MINIMUM" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The campaign budget cannot be shared.", +"The requested campaign budget no longer exists.", +"The campaign budget is associated with at least one campaign, and so the campaign budget cannot be removed.", +"Customer is not on the allow-list for this campaign budget period.", +"This field is not mutable on implicitly shared campaign budgets", +"Cannot change explicitly shared campaign budgets back to implicitly shared ones.", +"An implicit campaign budget without a name cannot be changed to explicitly shared campaign budget.", +"Cannot change an implicitly shared campaign budget to an explicitly shared one.", +"Only explicitly shared campaign budgets can be used with multiple campaigns.", +"A campaign budget with this name already exists.", +"A money amount was not in the expected currency.", +"A money amount was less than the minimum CPC for currency.", +"A money amount was greater than the maximum allowed.", +"A money amount was negative.", +"A money amount was not a multiple of a minimum unit.", +"Total budget amount must be unset when BudgetPeriod is DAILY.", +"The period of the budget is not allowed.", +"Cannot use accelerated delivery method on this budget.", +"Budget amount must be unset when BudgetPeriod is CUSTOM.", +"Budget amount or total amount must be above this campaign's per-day minimum. See the error's details.budget_per_day_minimum_error_details field for more information." +], +"type": "string" +}, +"campaignConversionGoalError": { +"description": "The reasons for the campaign conversion goal error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CANNOT_USE_CAMPAIGN_GOAL_FOR_SEARCH_ADS_360_MANAGED_CAMPAIGN", +"CANNOT_USE_STORE_SALE_GOAL_FOR_PERFORMANCE_MAX_CAMPAIGN" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Campaign is managed by Search Ads 360 but uses Unified Goal.", +"Performance Max campaign cannot use an included store sale campaign goal." +], +"type": "string" +}, +"campaignCriterionError": { +"description": "The reasons for the campaign criterion error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CONCRETE_TYPE_REQUIRED", +"INVALID_PLACEMENT_URL", +"CANNOT_EXCLUDE_CRITERIA_TYPE", +"CANNOT_SET_STATUS_FOR_CRITERIA_TYPE", +"CANNOT_SET_STATUS_FOR_EXCLUDED_CRITERIA", +"CANNOT_TARGET_AND_EXCLUDE", +"TOO_MANY_OPERATIONS", +"OPERATOR_NOT_SUPPORTED_FOR_CRITERION_TYPE", +"SHOPPING_CAMPAIGN_SALES_COUNTRY_NOT_SUPPORTED_FOR_SALES_CHANNEL", +"CANNOT_ADD_EXISTING_FIELD", +"CANNOT_UPDATE_NEGATIVE_CRITERION", +"CANNOT_SET_NEGATIVE_KEYWORD_THEME_CONSTANT_CRITERION", +"INVALID_KEYWORD_THEME_CONSTANT", +"MISSING_KEYWORD_THEME_CONSTANT_OR_FREE_FORM_KEYWORD_THEME", +"CANNOT_TARGET_BOTH_PROXIMITY_AND_LOCATION_CRITERIA_FOR_SMART_CAMPAIGN", +"CANNOT_TARGET_MULTIPLE_PROXIMITY_CRITERIA_FOR_SMART_CAMPAIGN", +"LOCATION_NOT_LAUNCHED_FOR_LOCAL_SERVICES_CAMPAIGN", +"LOCATION_INVALID_FOR_LOCAL_SERVICES_CAMPAIGN", +"CANNOT_TARGET_COUNTRY_FOR_LOCAL_SERVICES_CAMPAIGN", +"LOCATION_NOT_IN_HOME_COUNTRY_FOR_LOCAL_SERVICES_CAMPAIGN", +"CANNOT_ADD_OR_REMOVE_LOCATION_FOR_LOCAL_SERVICES_CAMPAIGN", +"AT_LEAST_ONE_POSITIVE_LOCATION_REQUIRED_FOR_LOCAL_SERVICES_CAMPAIGN", +"AT_LEAST_ONE_LOCAL_SERVICE_ID_CRITERION_REQUIRED_FOR_LOCAL_SERVICES_CAMPAIGN", +"LOCAL_SERVICE_ID_NOT_FOUND_FOR_CATEGORY", +"CANNOT_ATTACH_BRAND_LIST_TO_NON_QUALIFIED_SEARCH_CAMPAIGN", +"CANNOT_REMOVE_ALL_LOCATIONS_DUE_TO_TOO_MANY_COUNTRY_EXCLUSIONS", +"INVALID_VIDEO_LINEUP_ID" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Concrete type of criterion (keyword v.s. placement) is required for CREATE and UPDATE operations.", +"Invalid placement URL.", +"Criteria type can not be excluded for the campaign by the customer. like AOL account type cannot target site type criteria", +"Cannot set the campaign criterion status for this criteria type.", +"Cannot set the campaign criterion status for an excluded criteria.", +"Cannot target and exclude the same criterion.", +"The mutate contained too many operations.", +"This operator cannot be applied to a criterion of this type.", +"The Shopping campaign sales country is not supported for ProductSalesChannel targeting.", +"The existing field can't be updated with CREATE operation. It can be updated with UPDATE operation only.", +"Negative criteria are immutable, so updates are not allowed.", +"Only free form names are allowed for negative Smart campaign keyword theme.", +"Invalid Smart campaign keyword theme constant criterion.", +"A Smart campaign keyword theme constant or free-form Smart campaign keyword theme is required.", +"A Smart campaign may not target proximity and location criteria simultaneously.", +"A Smart campaign may not target multiple proximity criteria.", +"Location is not launched for Local Services Campaigns.", +"A Local Services campaign may not target certain criteria types.", +"Country locations are not supported for Local Services campaign.", +"Location is not within the home country of Local Services campaign.", +"Local Services profile does not exist for a particular Local Services campaign.", +"Local Services campaign must have at least one target location.", +"At least one positive local service ID criterion is required for a Local Services campaign.", +"Local service ID is not found under selected categories in local services campaign setting.", +"For search advertising channel, brand lists can only be applied to exclusive targeting, broad match campaigns for inclusive targeting or PMax generated campaigns.", +"Campaigns that target all countries and territories are limited to a certain number of top-level location exclusions. If removing a criterion causes the campaign to target all countries and territories and the campaign has more top-level location exclusions than the limit allows, then this error is returned.", +"Video lineup ID does not exist." +], +"type": "string" +}, +"campaignCustomizerError": { +"description": "The reasons for the campaign customizer error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version." +], +"type": "string" +}, +"campaignDraftError": { +"description": "The reasons for the campaign draft error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"DUPLICATE_DRAFT_NAME", +"INVALID_STATUS_TRANSITION_FROM_REMOVED", +"INVALID_STATUS_TRANSITION_FROM_PROMOTED", +"INVALID_STATUS_TRANSITION_FROM_PROMOTE_FAILED", +"CUSTOMER_CANNOT_CREATE_DRAFT", +"CAMPAIGN_CANNOT_CREATE_DRAFT", +"INVALID_DRAFT_CHANGE", +"INVALID_STATUS_TRANSITION", +"MAX_NUMBER_OF_DRAFTS_PER_CAMPAIGN_REACHED", +"LIST_ERRORS_FOR_PROMOTED_DRAFT_ONLY" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"A draft with this name already exists for this campaign.", +"The draft is removed and cannot be transitioned to another status.", +"The draft has been promoted and cannot be transitioned to the specified status.", +"The draft has failed to be promoted and cannot be transitioned to the specified status.", +"This customer is not allowed to create drafts.", +"This campaign is not allowed to create drafts.", +"This modification cannot be made on a draft.", +"The draft cannot be transitioned to the specified status from its current status.", +"The campaign has reached the maximum number of drafts that can be created for a campaign throughout its lifetime. No additional drafts can be created for this campaign. Removed drafts also count towards this limit.", +"ListAsyncErrors was called without first promoting the draft." +], +"type": "string" +}, +"campaignError": { +"description": "An error with a Campaign mutate.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CANNOT_TARGET_CONTENT_NETWORK", +"CANNOT_TARGET_SEARCH_NETWORK", +"CANNOT_TARGET_SEARCH_NETWORK_WITHOUT_GOOGLE_SEARCH", +"CANNOT_TARGET_GOOGLE_SEARCH_FOR_CPM_CAMPAIGN", +"CAMPAIGN_MUST_TARGET_AT_LEAST_ONE_NETWORK", +"CANNOT_TARGET_PARTNER_SEARCH_NETWORK", +"CANNOT_TARGET_CONTENT_NETWORK_ONLY_WITH_CRITERIA_LEVEL_BIDDING_STRATEGY", +"CAMPAIGN_DURATION_MUST_CONTAIN_ALL_RUNNABLE_TRIALS", +"CANNOT_MODIFY_FOR_TRIAL_CAMPAIGN", +"DUPLICATE_CAMPAIGN_NAME", +"INCOMPATIBLE_CAMPAIGN_FIELD", +"INVALID_CAMPAIGN_NAME", +"INVALID_AD_SERVING_OPTIMIZATION_STATUS", +"INVALID_TRACKING_URL", +"CANNOT_SET_BOTH_TRACKING_URL_TEMPLATE_AND_TRACKING_SETTING", +"MAX_IMPRESSIONS_NOT_IN_RANGE", +"TIME_UNIT_NOT_SUPPORTED", +"INVALID_OPERATION_IF_SERVING_STATUS_HAS_ENDED", +"BUDGET_CANNOT_BE_SHARED", +"CAMPAIGN_CANNOT_USE_SHARED_BUDGET", +"CANNOT_CHANGE_BUDGET_ON_CAMPAIGN_WITH_TRIALS", +"CAMPAIGN_LABEL_DOES_NOT_EXIST", +"CAMPAIGN_LABEL_ALREADY_EXISTS", +"MISSING_SHOPPING_SETTING", +"INVALID_SHOPPING_SALES_COUNTRY", +"ADVERTISING_CHANNEL_TYPE_NOT_AVAILABLE_FOR_ACCOUNT_TYPE", +"INVALID_ADVERTISING_CHANNEL_SUB_TYPE", +"AT_LEAST_ONE_CONVERSION_MUST_BE_SELECTED", +"CANNOT_SET_AD_ROTATION_MODE", +"CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED", +"CANNOT_SET_DATE_TO_PAST", +"MISSING_HOTEL_CUSTOMER_LINK", +"INVALID_HOTEL_CUSTOMER_LINK", +"MISSING_HOTEL_SETTING", +"CANNOT_USE_SHARED_CAMPAIGN_BUDGET_WHILE_PART_OF_CAMPAIGN_GROUP", +"APP_NOT_FOUND", +"SHOPPING_ENABLE_LOCAL_NOT_SUPPORTED_FOR_CAMPAIGN_TYPE", +"MERCHANT_NOT_ALLOWED_FOR_COMPARISON_LISTING_ADS", +"INSUFFICIENT_APP_INSTALLS_COUNT", +"SENSITIVE_CATEGORY_APP", +"HEC_AGREEMENT_REQUIRED", +"NOT_COMPATIBLE_WITH_VIEW_THROUGH_CONVERSION_OPTIMIZATION", +"INVALID_EXCLUDED_PARENT_ASSET_FIELD_TYPE", +"CANNOT_CREATE_APP_PRE_REGISTRATION_FOR_NON_ANDROID_APP", +"APP_NOT_AVAILABLE_TO_CREATE_APP_PRE_REGISTRATION_CAMPAIGN", +"INCOMPATIBLE_BUDGET_TYPE", +"LOCAL_SERVICES_DUPLICATE_CATEGORY_BID", +"LOCAL_SERVICES_INVALID_CATEGORY_BID", +"LOCAL_SERVICES_MISSING_CATEGORY_BID", +"INVALID_STATUS_CHANGE", +"MISSING_TRAVEL_CUSTOMER_LINK", +"INVALID_TRAVEL_CUSTOMER_LINK", +"INVALID_EXCLUDED_PARENT_ASSET_SET_TYPE", +"ASSET_SET_NOT_A_HOTEL_PROPERTY_ASSET_SET", +"HOTEL_PROPERTY_ASSET_SET_ONLY_FOR_PERFORMANCE_MAX_FOR_TRAVEL_GOALS", +"AVERAGE_DAILY_SPEND_TOO_HIGH", +"CANNOT_ATTACH_TO_REMOVED_CAMPAIGN_GROUP", +"CANNOT_ATTACH_TO_BIDDING_STRATEGY", +"CANNOT_CHANGE_BUDGET_PERIOD", +"NOT_ENOUGH_CONVERSIONS", +"CANNOT_SET_MORE_THAN_ONE_CONVERSION_ACTION", +"NOT_COMPATIBLE_WITH_BUDGET_TYPE", +"NOT_COMPATIBLE_WITH_UPLOAD_CLICKS_CONVERSION", +"APP_ID_MUST_MATCH_CONVERSION_ACTION_APP_ID", +"CONVERSION_ACTION_WITH_DOWNLOAD_CATEGORY_NOT_ALLOWED", +"CONVERSION_ACTION_WITH_DOWNLOAD_CATEGORY_REQUIRED", +"CONVERSION_TRACKING_NOT_ENABLED", +"NOT_COMPATIBLE_WITH_BIDDING_STRATEGY_TYPE", +"NOT_COMPATIBLE_WITH_GOOGLE_ATTRIBUTION_CONVERSIONS", +"CONVERSION_LAG_TOO_HIGH", +"NOT_LINKED_ADVERTISING_PARTNER", +"INVALID_NUMBER_OF_ADVERTISING_PARTNER_IDS", +"CANNOT_TARGET_DISPLAY_NETWORK_WITHOUT_YOUTUBE", +"CANNOT_LINK_TO_COMPARISON_SHOPPING_SERVICE_ACCOUNT", +"CANNOT_TARGET_NETWORK_FOR_COMPARISON_SHOPPING_SERVICE_LINKED_ACCOUNTS", +"CANNOT_MODIFY_TEXT_ASSET_AUTOMATION_WITH_ENABLED_TRIAL", +"DYNAMIC_TEXT_ASSET_CANNOT_OPT_OUT_WITH_FINAL_URL_EXPANSION_OPT_IN", +"CANNOT_SET_CAMPAIGN_KEYWORD_MATCH_TYPE", +"CANNOT_DISABLE_BROAD_MATCH_WHEN_KEYWORD_CONVERSION_IN_PROCESS", +"CANNOT_DISABLE_BROAD_MATCH_WHEN_TARGETING_BRANDS", +"CANNOT_ENABLE_BROAD_MATCH_FOR_BASE_CAMPAIGN_WITH_PROMOTING_TRIAL", +"CANNOT_ENABLE_BROAD_MATCH_FOR_PROMOTING_TRIAL_CAMPAIGN", +"REQUIRED_BUSINESS_NAME_ASSET_NOT_LINKED", +"REQUIRED_LOGO_ASSET_NOT_LINKED", +"BRAND_TARGETING_OVERRIDES_NOT_SUPPORTED", +"BRAND_GUIDELINES_NOT_ENABLED_FOR_CAMPAIGN", +"BRAND_GUIDELINES_MAIN_AND_ACCENT_COLORS_REQUIRED", +"BRAND_GUIDELINES_COLOR_INVALID_FORMAT", +"BRAND_GUIDELINES_UNSUPPORTED_FONT_FAMILY", +"BRAND_GUIDELINES_UNSUPPORTED_CHANNEL", +"CANNOT_ENABLE_BRAND_GUIDELINES_FOR_TRAVEL_GOALS", +"CUSTOMER_NOT_ALLOWLISTED_FOR_BRAND_GUIDELINES", +"THIRD_PARTY_INTEGRATION_PARTNER_NOT_ALLOWED", +"THIRD_PARTY_INTEGRATION_PARTNER_SHARE_COST_NOT_ALLOWED", +"DUPLICATE_INTERACTION_TYPE", +"INVALID_INTERACTION_TYPE", +"VIDEO_SEQUENCE_ERROR_SEQUENCE_DEFINITION_REQUIRED", +"AI_MAX_MUST_BE_ENABLED", +"DURATION_TOO_LONG_FOR_TOTAL_BUDGET", +"END_DATE_TIME_REQUIRED_FOR_TOTAL_BUDGET" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Cannot target content network.", +"Cannot target search network.", +"Cannot cover search network without google search network.", +"Cannot target Google Search network for a CPM campaign.", +"Must target at least one network.", +"Only some Google partners are allowed to target partner search network.", +"Cannot target content network only as campaign has criteria-level bidding strategy.", +"Cannot modify the start or end date such that the campaign duration would not contain the durations of all runnable trials.", +"Cannot modify dates, budget or status of a trial campaign.", +"Trying to modify the name of an active or paused campaign, where the name is already assigned to another active or paused campaign.", +"Two fields are in conflicting modes.", +"Campaign name cannot be used.", +"Given status is invalid.", +"Error in the campaign level tracking URL.", +"Cannot set both tracking URL template and tracking setting. A user has to clear legacy tracking setting in order to add tracking URL template.", +"The maximum number of impressions for Frequency Cap should be an integer greater than 0.", +"Only the Day, Week and Month time units are supported.", +"Operation not allowed on a campaign whose serving status has ended", +"This budget is exclusively linked to a Campaign that is using experiments so it cannot be shared.", +"Campaigns using experiments cannot use a shared budget.", +"A different budget cannot be assigned to a campaign when there are running or scheduled trials.", +"No link found between the campaign and the label.", +"The label has already been attached to the campaign.", +"A ShoppingSetting was not found when creating a shopping campaign.", +"The country in shopping setting is not an allowed country.", +"The requested channel type is not available according to the customer's account setting.", +"The AdvertisingChannelSubType is not a valid subtype of the primary channel type.", +"At least one conversion must be selected.", +"Setting ad rotation mode for a campaign is not allowed. Ad rotation mode at campaign is deprecated.", +"Trying to change start date on a campaign that has started.", +"Trying to modify a date into the past.", +"Hotel center id in the hotel setting does not match any customer links.", +"Hotel center id in the hotel setting must match an active customer link.", +"Hotel setting was not found when creating a hotel ads campaign.", +"A Campaign cannot use shared campaign budgets and be part of a campaign group.", +"The app ID was not found.", +"Campaign.shopping_setting.enable_local is not supported for the specified campaign type.", +"The merchant does not support the creation of campaigns for Shopping Comparison Listing Ads.", +"The App campaign for engagement cannot be created because there aren't enough installs.", +"The App campaign for engagement cannot be created because the app is sensitive.", +"Customers with Housing, Employment, or Credit ads must accept updated personalized ads policy to continue creating campaigns.", +"The field is not compatible with view through conversion optimization.", +"The field type cannot be excluded because an active campaign-asset link of this type exists.", +"The app pre-registration campaign cannot be created for non-Android applications.", +"The campaign cannot be created since the app is not available for pre-registration in any country.", +"The type of the Budget is not compatible with this Campaign.", +"Category bid list in the local services campaign setting contains multiple bids for the same category ID.", +"Category bid list in the local services campaign setting contains a bid for an invalid category ID.", +"Category bid list in the local services campaign setting is missing a bid for a category ID that must be present.", +"The requested change in status is not supported.", +"Travel Campaign's travel_account_id does not match any customer links.", +"Travel Campaign's travel_account_id matches an existing customer link but the customer link is not active.", +"The asset set type is invalid to be set in excluded_parent_asset_set_types field.", +"Campaign.hotel_property_asset_set must point to an asset set of type HOTEL_PROPERTY.", +"The hotel property asset set can only be set on Performance Max for travel goals campaigns.", +"Customer's average daily spend is too high to enable this feature.", +"Cannot attach the campaign to a deleted campaign group.", +"Cannot attach the campaign to this bidding strategy.", +"A budget with a different period cannot be assigned to the campaign.", +"Customer does not have enough conversions to enable this feature.", +"This campaign type can only have one conversion action.", +"The field is not compatible with the budget type.", +"The feature is incompatible with ConversionActionType.UPLOAD_CLICKS.", +"App campaign setting app ID must match selective optimization conversion action app ID.", +"Selective optimization conversion action with Download category is not allowed.", +"One software download for selective optimization conversion action is required for this campaign conversion action.", +"Conversion tracking is not enabled and is required for this feature.", +"The field is not compatible with the bidding strategy type.", +"Campaign is not compatible with a conversion tracker that has Google attribution enabled.", +"Customer level conversion lag is too high.", +"The advertiser set as an advertising partner is not an actively linked advertiser to this customer.", +"Invalid number of advertising partner IDs.", +"Cannot target the display network without also targeting YouTube.", +"This campaign type cannot be linked to a Comparison Shopping Service account.", +"Standard Shopping campaigns that are linked to a Comparison Shopping Service account cannot target this network.", +"Text asset automation settings can not be modified when there is an active Performance Max optimization automatically created assets experiment. End the experiment to modify these settings.", +"Dynamic text asset cannot be opted out when final URL expansion is opted in.", +"Can not set a campaign level match type.", +"The campaign level keyword match type cannot be switched to non-broad when keyword conversion to broad match is in process.", +"The campaign level keyword match type cannot be switched to non-broad when the campaign has any attached brand list or when a brand hint shared set is attached to the campaign.", +"Cannot set campaign level keyword match type to BROAD if the campaign is a base campaign with an associated trial that is currently promoting.", +"Cannot set campaign level keyword match type to BROAD if the campaign is a trial currently promoting.", +"Performance Max campaigns with Brand Guidelines enabled require at least one business name to be linked as a CampaignAsset. Performance Max campaigns for online sales with a product feed must meet this requirement only when there are assets that are linked to the campaign's asset groups.", +"Performance Max campaigns with Brand Guidelines enabled require at least one square logo to be linked as a CampaignAsset. Performance Max campaigns for online sales with a product feed must meet this requirement only when there are assets that are linked to the campaign's asset groups.", +"This campaign does not support brand targeting overrides. Brand targeting overrides are only supported for Performance Max campaigns that have a product feed.", +"Brand Guideline fields can only be set for campaigns that have Brand Guidelines enabled.", +"When a Brand Guidelines color field is set, both main color and accent color are required.", +"Brand Guidelines colors must be hex colors matching the regular expression '#[0-9a-fA-F]{6}', for example '#abc123'", +"Brand Guidelines font family must be one of the supported Google Fonts. See Campaign.brand_guidelines.predefined_font_family for the list of supported fonts.", +"Brand Guidelines cannot be set for this channel type. Brand Guidelines supports Performance Max campaigns.", +"Brand Guidelines cannot be enabled for Performance Max for travel goals campaigns.", +"This customer is not allowlisted for enabling Brand Guidelines.", +"Using campaign third-party integration partners that are not set at the customer level is not allowed.", +"Campaign third-party integration partners are not allowed to share cost if it is not enabled at the customer level.", +"Each `previous_step_interaction_type` can be used at most once for the same `previous_step_id`", +"Previous step interaction type cannot happen for previous step AdGroup type. For example, `SKIP` interaction type is not valid for non-skippable formats.", +"Campaign video ads sequence is required for `VIDEO_SEQUENCE` advertising channel sub type.", +"This feature is only available for campaigns with AI Max enabled.", +"Duration too long for total budget.", +"Campaigns with total budgets must have end date/time specified." +], +"type": "string" +}, +"campaignExperimentError": { +"description": "The reasons for the campaign experiment error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"DUPLICATE_NAME", +"INVALID_TRANSITION", +"CANNOT_CREATE_EXPERIMENT_WITH_SHARED_BUDGET", +"CANNOT_CREATE_EXPERIMENT_FOR_REMOVED_BASE_CAMPAIGN", +"CANNOT_CREATE_EXPERIMENT_FOR_NON_PROPOSED_DRAFT", +"CUSTOMER_CANNOT_CREATE_EXPERIMENT", +"CAMPAIGN_CANNOT_CREATE_EXPERIMENT", +"EXPERIMENT_DURATIONS_MUST_NOT_OVERLAP", +"EXPERIMENT_DURATION_MUST_BE_WITHIN_CAMPAIGN_DURATION", +"CANNOT_MUTATE_EXPERIMENT_DUE_TO_STATUS" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"An active campaign or experiment with this name already exists.", +"Experiment cannot be updated from the current state to the requested target state. For example, an experiment can only graduate if its status is ENABLED.", +"Cannot create an experiment from a campaign using an explicitly shared budget.", +"Cannot create an experiment for a removed base campaign.", +"Cannot create an experiment from a draft, which has a status other than proposed.", +"This customer is not allowed to create an experiment.", +"This campaign is not allowed to create an experiment.", +"Trying to set an experiment duration which overlaps with another experiment.", +"All non-removed experiments must start and end within their campaign's duration.", +"The experiment cannot be modified because its status is in a terminal state, such as REMOVED." +], +"type": "string" +}, +"campaignFeedError": { +"description": "The reasons for the campaign feed error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"FEED_ALREADY_EXISTS_FOR_PLACEHOLDER_TYPE", +"CANNOT_CREATE_FOR_REMOVED_FEED", +"CANNOT_CREATE_ALREADY_EXISTING_CAMPAIGN_FEED", +"CANNOT_MODIFY_REMOVED_CAMPAIGN_FEED", +"INVALID_PLACEHOLDER_TYPE", +"MISSING_FEEDMAPPING_FOR_PLACEHOLDER_TYPE", +"NO_EXISTING_LOCATION_CUSTOMER_FEED", +"LEGACY_FEED_TYPE_READ_ONLY" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"An active feed already exists for this campaign and placeholder type.", +"The specified feed is removed.", +"The CampaignFeed already exists. UPDATE should be used to modify the existing CampaignFeed.", +"Cannot update removed campaign feed.", +"Invalid placeholder type.", +"Feed mapping for this placeholder type does not exist.", +"Location CampaignFeeds cannot be created unless there is a location CustomerFeed for the specified feed.", +"Feed is read only." +], +"type": "string" +}, +"campaignGoalConfigError": { +"description": "The reasons for the campaign goal config error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"GOAL_NOT_FOUND", +"CAMPAIGN_NOT_FOUND", +"HIGH_LIFETIME_VALUE_PRESENT_BUT_VALUE_ABSENT", +"HIGH_LIFETIME_VALUE_LESS_THAN_OR_EQUAL_TO_VALUE", +"CUSTOMER_LIFECYCLE_OPTIMIZATION_CAMPAIGN_TYPE_NOT_SUPPORTED", +"CUSTOMER_NOT_ALLOWLISTED_FOR_RETENTION_ONLY" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Goal is either removed or does not exist for this account.", +"Campaign is either removed or does not exist.", +"If high lifetime value is present then value should be present.", +"High lifetime value should be greater than value.", +"When using customer lifecycle optimization goal, campaign type should be supported.", +"Customer must be allowlisted to use retention only goal." +], +"type": "string" +}, +"campaignLifecycleGoalError": { +"description": "The reasons for the campaign lifecycle goal error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CAMPAIGN_MISSING", +"INVALID_CAMPAIGN", +"CUSTOMER_ACQUISITION_INVALID_OPTIMIZATION_MODE", +"INCOMPATIBLE_BIDDING_STRATEGY", +"MISSING_PURCHASE_GOAL", +"CUSTOMER_ACQUISITION_INVALID_HIGH_LIFETIME_VALUE", +"CUSTOMER_ACQUISITION_UNSUPPORTED_CAMPAIGN_TYPE", +"CUSTOMER_ACQUISITION_INVALID_VALUE", +"CUSTOMER_ACQUISITION_VALUE_MISSING", +"CUSTOMER_ACQUISITION_MISSING_EXISTING_CUSTOMER_DEFINITION", +"CUSTOMER_ACQUISITION_MISSING_HIGH_VALUE_CUSTOMER_DEFINITION" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Campaign is not specified.", +"Cannot find the specified campaign.", +"Optimization mode is unspecified or invalid.", +"The configured lifecycle goal setting is not compatible with the bidding strategy the campaign is using. Specifically, BID_HIGHER_FOR_NEW_CUSTOMER requires conversion-value based bidding strategy type such as MAXIMIZE_CONVERSION_VALUE.", +"Lifecycle goals require the campaign to optimize towards purchase conversion goal.", +"CampaignLifecycleGoal.customer_acquisition_goal_settings.value_settings.high_lifetime_value is invalid or not allowed, such as when the specified value is smaller than 0.01, when the optimization mode is not BID_HIGHER_FOR_NEW_CUSTOMER, or when CampaignLifecycleGoal.customer_acquisition_goal_settings.value_settings.high_lifetime_value is specified smaller than/without CampaignLifecycleGoal.customer_acquisition_goal_settings.value_settings.value.", +"Customer acquisition goal is not supported on this campaign type.", +"CampaignLifecycleGoal.customer_acquisition_goal_settings.value_settings.value is invalid or not allowed, such as when the specified value is smaller than 0.01, or when the optimization mode is not BID_HIGHER_FOR_NEW_CUSTOMER.", +"To use BID_HIGHER_FOR_NEW_CUSTOMER mode, either CampaignLifecycleGoal.customer_acquisition_goal_settings.value_settings.value or CustomerLifecycleGoal.customer_acquisition_goal_value_settings.value must have been specified. If a manager account is managing your account's conversion tracking, then only the CustomerLifecycleGoal of that manager account is used.", +"In order for a campaign to adopt the customer acquisition goal, CustomerLifecycleGoal.lifecycle_goal_customer_definition_settings.existing_user_lists must include active and accessible userlist with more than 1000 members in the Search/Youtube network. If a manager account is managing your account's conversion tracking, then only the CustomerLifecycleGoal of that manager account is used. Also make sure that the manager account shares audience segments with sub-accounts with continuous audience sharing.", +"In order for a campaign to adopt the customer acquisition goal with high lifetime value optimization, CustomerLifecycleGoal.lifecycle_goal_customer_definition_settings.high_lifetime_value_user_lists must include active and accessible userlist with more than 1000 members in the Search/Youtube network. If a manager account is managing your account's conversion tracking, then only the CustomerLifecycleGoal of that manager account is used. Also make sure that the manager account shares audience segments with sub-accounts using continuous audience sharing." +], +"type": "string" +}, +"campaignSharedSetError": { +"description": "The reasons for the campaign shared set error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"SHARED_SET_ACCESS_DENIED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The shared set belongs to another customer and permission isn't granted." +], +"type": "string" +}, +"changeEventError": { +"description": "The reasons for the change event error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"START_DATE_TOO_OLD", +"CHANGE_DATE_RANGE_INFINITE", +"CHANGE_DATE_RANGE_NEGATIVE", +"LIMIT_NOT_SPECIFIED", +"INVALID_LIMIT_CLAUSE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The requested start date is too old. It cannot be older than 30 days.", +"The change_event search request must specify a finite range filter on change_date_time.", +"The change event search request has specified invalid date time filters that can never logically produce any valid results (for example, start time after end time).", +"The change_event search request must specify a LIMIT.", +"The LIMIT specified by change_event request should be less than or equal to 10K." +], +"type": "string" +}, +"changeStatusError": { +"description": "The reasons for the change status error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"START_DATE_TOO_OLD", +"CHANGE_DATE_RANGE_INFINITE", +"CHANGE_DATE_RANGE_NEGATIVE", +"LIMIT_NOT_SPECIFIED", +"INVALID_LIMIT_CLAUSE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The requested start date is too old.", +"The change_status search request must specify a finite range filter on last_change_date_time.", +"The change status search request has specified invalid date time filters that can never logically produce any valid results (for example, start time after end time).", +"The change_status search request must specify a LIMIT.", +"The LIMIT specified by change_status request should be less than or equal to 10K." +], +"type": "string" +}, +"clickViewError": { +"description": "The reasons for the click view error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"EXPECTED_FILTER_ON_A_SINGLE_DAY", +"DATE_TOO_OLD" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Missing filter on a single day.", +"The requested date is too old." +], +"type": "string" +}, +"collectionSizeError": { +"description": "The reasons for the collection size error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"TOO_FEW", +"TOO_MANY" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Too few.", +"Too many." +], +"type": "string" +}, +"contextError": { +"description": "The reasons for the context error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"OPERATION_NOT_PERMITTED_FOR_CONTEXT", +"OPERATION_NOT_PERMITTED_FOR_REMOVED_RESOURCE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The operation is not allowed for the given context.", +"The operation is not allowed for removed resources." +], +"type": "string" +}, +"conversionActionError": { +"description": "The reasons for the conversion action error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"DUPLICATE_NAME", +"DUPLICATE_APP_ID", +"TWO_CONVERSION_ACTIONS_BIDDING_ON_SAME_APP_DOWNLOAD", +"BIDDING_ON_SAME_APP_DOWNLOAD_AS_GLOBAL_ACTION", +"DATA_DRIVEN_MODEL_WAS_NEVER_GENERATED", +"DATA_DRIVEN_MODEL_EXPIRED", +"DATA_DRIVEN_MODEL_STALE", +"DATA_DRIVEN_MODEL_UNKNOWN", +"CREATION_NOT_SUPPORTED", +"UPDATE_NOT_SUPPORTED", +"CANNOT_SET_RULE_BASED_ATTRIBUTION_MODELS" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The specified conversion action name already exists.", +"Another conversion action with the specified app id already exists.", +"Android first open action conflicts with Google play codeless download action tracking the same app.", +"Android first open action conflicts with Google play codeless download action tracking the same app.", +"The attribution model cannot be set to DATA_DRIVEN because a data-driven model has never been generated.", +"The attribution model cannot be set to DATA_DRIVEN because the data-driven model is expired.", +"The attribution model cannot be set to DATA_DRIVEN because the data-driven model is stale.", +"The attribution model cannot be set to DATA_DRIVEN because the data-driven model is unavailable or the conversion action was newly added.", +"Creation of this conversion action type isn't supported by Google Ads API.", +"Update of this conversion action isn't supported by Google Ads API.", +"Rule-based attribution models are deprecated and not allowed to be set by conversion action." +], +"type": "string" +}, +"conversionAdjustmentUploadError": { +"description": "The reasons for the conversion adjustment upload error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"TOO_RECENT_CONVERSION_ACTION", +"CONVERSION_ALREADY_RETRACTED", +"CONVERSION_NOT_FOUND", +"CONVERSION_EXPIRED", +"ADJUSTMENT_PRECEDES_CONVERSION", +"MORE_RECENT_RESTATEMENT_FOUND", +"TOO_RECENT_CONVERSION", +"CANNOT_RESTATE_CONVERSION_ACTION_THAT_ALWAYS_USES_DEFAULT_CONVERSION_VALUE", +"TOO_MANY_ADJUSTMENTS_IN_REQUEST", +"TOO_MANY_ADJUSTMENTS", +"RESTATEMENT_ALREADY_EXISTS", +"DUPLICATE_ADJUSTMENT_IN_REQUEST", +"CUSTOMER_NOT_ACCEPTED_CUSTOMER_DATA_TERMS", +"CONVERSION_ACTION_NOT_ELIGIBLE_FOR_ENHANCEMENT", +"INVALID_USER_IDENTIFIER", +"UNSUPPORTED_USER_IDENTIFIER", +"GCLID_DATE_TIME_PAIR_AND_ORDER_ID_BOTH_SET", +"CONVERSION_ALREADY_ENHANCED", +"DUPLICATE_ENHANCEMENT_IN_REQUEST", +"CUSTOMER_DATA_POLICY_PROHIBITS_ENHANCEMENT", +"MISSING_ORDER_ID_FOR_WEBPAGE", +"ORDER_ID_CONTAINS_PII", +"INVALID_JOB_ID", +"NO_CONVERSION_ACTION_FOUND", +"INVALID_CONVERSION_ACTION_TYPE" +], +"enumDescriptions": [ +"Not specified.", +"Used for return value only. Represents value unknown in this version.", +"Can't import events to a conversion action that was just created. Try importing again in 6 hours.", +"The conversion was already retracted. This adjustment was not processed.", +"The conversion for this conversion action and conversion identifier can't be found. Make sure your conversion identifiers are associated with the correct conversion action and try again.", +"Adjustment can't be made to a conversion that occurred more than 54 days ago.", +"Adjustment has an `adjustment_date_time` that occurred before the associated conversion. Make sure your `adjustment_date_time` is correct and try again.", +"More recent adjustment `adjustment_date_time` has already been reported for the associated conversion. Make sure your adjustment `adjustment_date_time` is correct and try again.", +"Adjustment can't be recorded because the conversion occurred too recently. Try adjusting a conversion that occurred at least 24 hours ago.", +"Can't make an adjustment to a conversion that is set up to use the default value. Check your conversion action value setting and try again.", +"Try uploading fewer than 2001 adjustments in a single API request.", +"The conversion has already been adjusted the maximum number of times. Make sure you're only making necessary adjustment to existing conversion.", +"The conversion has prior a restatement with the same `adjustment_date_time`. Make sure your adjustment has the correct and unique `adjustment_date_time` and try again.", +"Imported adjustment has a duplicate conversion adjustment with same `adjustment_date_time`. Make sure your adjustment has the correct `adjustment_date_time` and try again.", +"Make sure you agree to the customer data processing terms in conversion settings and try again.", +"Can't use enhanced conversions with the specified conversion action.", +"Make sure you hash user provided data using SHA-256 and ensure you are normalizing according to the guidelines.", +"Use user provided data such as emails or phone numbers hashed using SHA-256 and try again.", +"Cannot set both gclid_date_time_pair and order_id. Use only 1 type and try again.", +"Conversion already has enhancements with the same Order ID and conversion action. Make sure your data is correctly configured and try again.", +"Multiple enhancements have the same conversion action and Order ID. Make sure your data is correctly configured and try again.", +"Enhanced conversions can't be used for this account because of Google customer data policies. Contact your Google representative.", +"Adjustment for website conversion requires Order ID (ie, transaction ID). Make sure your website tags capture Order IDs and you send the same Order IDs with your adjustment.", +"Can't use adjustment with Order IDs containing personally-identifiable information (PII).", +"The provided job id in the request is not within the allowed range. A job ID must be a positive integer in the range [1, 2^31).", +"The conversion action specified in the adjustment request cannot be found. Make sure it's available in this account.", +"The type of the conversion action specified in the adjustment request isn't supported for uploading adjustments. A conversion adjustment of type `RETRACTION` or `RESTATEMENT` is only permitted for conversion actions of type `SALESFORCE`, `UPLOAD_CLICK` or `WEBPAGE`. A conversion adjustment of type `ENHANCEMENT` is only permitted for conversion actions of type `WEBPAGE`." +], +"type": "string" +}, +"conversionCustomVariableError": { +"description": "The reasons for the conversion custom variable error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"DUPLICATE_NAME", +"DUPLICATE_TAG", +"RESERVED_TAG" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"A conversion custom variable with the specified name already exists.", +"A conversion custom variable with the specified tag already exists.", +"A conversion custom variable with the specified tag is reserved for other uses." +], +"type": "string" +}, +"conversionGoalCampaignConfigError": { +"description": "The reasons for the conversion goal campaign config error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CANNOT_USE_CAMPAIGN_GOAL_FOR_SEARCH_ADS_360_MANAGED_CAMPAIGN", +"CUSTOM_GOAL_DOES_NOT_BELONG_TO_GOOGLE_ADS_CONVERSION_CUSTOMER", +"CAMPAIGN_CANNOT_USE_UNIFIED_GOALS", +"EMPTY_CONVERSION_GOALS", +"STORE_SALE_STORE_VISIT_CANNOT_BE_BOTH_INCLUDED", +"PERFORMANCE_MAX_CAMPAIGN_CANNOT_USE_CUSTOM_GOAL_WITH_STORE_SALES" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Campaign is managed by Search Ads 360 but uses Unified Goal.", +"The campaign is using a custom goal that does not belong to its Google Ads conversion customer (conversion tracking customer).", +"The campaign is not allowed to use unified goals.", +"The campaign is using campaign override goals but has no goals configured.", +"STORE_SALE and STORE_VISIT conversion types cannot be both included in campaign level goal.", +"Performance Max campaign is not allowed to use custom goal with store sales conversion type." +], +"type": "string" +}, +"conversionUploadError": { +"description": "The reasons for the conversion upload error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"TOO_MANY_CONVERSIONS_IN_REQUEST", +"UNPARSEABLE_GCLID", +"CONVERSION_PRECEDES_EVENT", +"EXPIRED_EVENT", +"TOO_RECENT_EVENT", +"EVENT_NOT_FOUND", +"UNAUTHORIZED_CUSTOMER", +"TOO_RECENT_CONVERSION_ACTION", +"CONVERSION_TRACKING_NOT_ENABLED_AT_IMPRESSION_TIME", +"EXTERNAL_ATTRIBUTION_DATA_SET_FOR_NON_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION", +"EXTERNAL_ATTRIBUTION_DATA_NOT_SET_FOR_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION", +"ORDER_ID_NOT_PERMITTED_FOR_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION", +"ORDER_ID_ALREADY_IN_USE", +"DUPLICATE_ORDER_ID", +"TOO_RECENT_CALL", +"EXPIRED_CALL", +"CALL_NOT_FOUND", +"CONVERSION_PRECEDES_CALL", +"CONVERSION_TRACKING_NOT_ENABLED_AT_CALL_TIME", +"UNPARSEABLE_CALLERS_PHONE_NUMBER", +"CLICK_CONVERSION_ALREADY_EXISTS", +"CALL_CONVERSION_ALREADY_EXISTS", +"DUPLICATE_CLICK_CONVERSION_IN_REQUEST", +"DUPLICATE_CALL_CONVERSION_IN_REQUEST", +"CUSTOM_VARIABLE_NOT_ENABLED", +"CUSTOM_VARIABLE_VALUE_CONTAINS_PII", +"INVALID_CUSTOMER_FOR_CLICK", +"INVALID_CUSTOMER_FOR_CALL", +"CONVERSION_NOT_COMPLIANT_WITH_ATT_POLICY", +"CLICK_NOT_FOUND", +"INVALID_USER_IDENTIFIER", +"EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION_NOT_PERMITTED_WITH_USER_IDENTIFIER", +"UNSUPPORTED_USER_IDENTIFIER", +"GBRAID_WBRAID_BOTH_SET", +"UNPARSEABLE_WBRAID", +"UNPARSEABLE_GBRAID", +"ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID", +"CUSTOMER_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS", +"CUSTOMER_NOT_ACCEPTED_CUSTOMER_DATA_TERMS", +"ORDER_ID_CONTAINS_PII", +"CUSTOMER_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS", +"INVALID_JOB_ID", +"NO_CONVERSION_ACTION_FOUND", +"INVALID_CONVERSION_ACTION_TYPE" +], +"enumDescriptions": [ +"Enum unspecified.", +"Used for return value only. Represents value unknown in this version.", +"Upload fewer than 2001 events in a single request.", +"The imported gclid could not be decoded.", +"The imported event has a `conversion_date_time` that precedes the click. Make sure your `conversion_date_time` is correct and try again.", +"The imported event can't be recorded because its click occurred before this conversion's click-through window. Make sure you import the most recent data.", +"The click associated with the given identifier or iOS URL parameter occurred less than 6 hours ago. Retry after 6 hours have passed.", +"The imported event could not be attributed to a click. This may be because the event did not come from a Google Ads campaign.", +"The click ID or call is associated with an Ads account you don't have access to. Make sure you import conversions for accounts managed by your manager account.", +"Can't import events to a conversion action that was just created. Try importing again in 6 hours.", +"At the time of the click, conversion tracking was not enabled in the effective conversion account of the click's Google Ads account.", +"The imported event includes external attribution data, but the conversion action isn't set up to use an external attribution model. Make sure the conversion action is correctly configured and try again.", +"The conversion action is set up to use an external attribution model, but the imported event is missing data. Make sure imported events include the external attribution credit and all necessary fields.", +"Order IDs can't be used for a conversion measured with an external attribution model. Make sure the conversion is correctly configured and imported events include only necessary data and try again.", +"The imported event includes an order ID that was previously recorded, so the event was not processed.", +"Imported events include multiple conversions with the same order ID and were not processed. Make sure order IDs are unique and try again.", +"Can't import calls that occurred less than 6 hours ago. Try uploading again in 6 hours.", +"The call can't be recorded because it occurred before this conversion action's lookback window. Make sure your import is configured to get the most recent data.", +"The call or click leading to the imported event can't be found. Make sure your data source is set up to include correct identifiers.", +"The call has a `conversion_date_time` that precedes the associated click. Make sure your `conversion_date_time` is correct.", +"At the time of the imported call, conversion tracking was not enabled in the effective conversion account of the click's Google Ads account.", +"Make sure phone numbers are formatted as E.164 (+16502531234), International (+64 3-331 6005), or US national number (6502531234).", +"The imported event has the same click and `conversion_date_time` as an existing conversion. Use a unique `conversion_date_time` or order ID for each unique event and try again.", +"The imported call has the same `conversion_date_time` as an existing conversion. Make sure your `conversion_date_time` correctly configured and try again.", +"Multiple events have the same click and `conversion_date_time`. Make sure your `conversion_date_time` is correctly configured and try again.", +"Multiple events have the same call and `conversion_date_time`. Make sure your `conversion_date_time` is correctly configured and try again.", +"Enable the custom variable in your conversion settings and try again.", +"Can't import events with custom variables containing personally-identifiable information (PII). Remove these variables and try again.", +"The click from the imported event is associated with a different Google Ads account. Make sure you're importing to the correct account.", +"The click from the call is associated with a different Google Ads account. Make sure you're importing to the correct account. Query conversion_tracking_setting.google_ads_conversion_customer on Customer to identify the correct account.", +"The connversion can't be imported because the conversion source didn't comply with Apple App Transparency Tracking (ATT) policies or because the customer didn't consent to tracking.", +"The email address or phone number for this event can't be matched to a click. This may be because it didn't come from a Google Ads campaign, and you can safely ignore this warning. If this includes more imported events than is expected, you may need to check your setup.", +"Make sure you hash user provided data using SHA-256 and ensure you are normalizing according to the guidelines.", +"User provided data can't be used with external attribution models. Use a different attribution model or omit user identifiers and try again.", +"The provided user identifiers are not supported. Use only hashed email or phone number and try again.", +"Can't use both gbraid and wbraid parameters. Use only 1 and try again.", +"Can't parse event import data. Check if your wbraid parameter was not modified and try again.", +"Can't parse event import data. Check if your gbraid parameter was not modified and try again.", +"Conversion actions that use one-per-click counting can't be used with gbraid or wbraid parameters.", +"Enhanced conversions can't be used for this account because of Google customer data policies. Contact your Google representative.", +"Make sure you agree to the customer data processing terms in conversion settings and try again. You can check your setting by querying conversion_tracking_setting.accepted_customer_data_terms on Customer.", +"Can't import events with order IDs containing personally-identifiable information (PII).", +"Make sure you've turned on enhanced conversions for leads in conversion settings and try again. You can check your setting by querying conversion_tracking_setting.enhanced_conversions_for_leads_enabled on Customer.", +"The provided job id in the request is not within the allowed range. A job ID must be a positive integer in the range [1, 2^31).", +"The conversion action specified in the upload request cannot be found. Make sure it's available in this account.", +"The conversion action specified in the upload request isn't set up for uploading conversions." +], +"type": "string" +}, +"conversionValueRuleError": { +"description": "The reasons for the conversion value rule error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_GEO_TARGET_CONSTANT", +"CONFLICTING_INCLUDED_AND_EXCLUDED_GEO_TARGET", +"CONFLICTING_CONDITIONS", +"CANNOT_REMOVE_IF_INCLUDED_IN_VALUE_RULE_SET", +"CONDITION_NOT_ALLOWED", +"FIELD_MUST_BE_UNSET", +"CANNOT_PAUSE_UNLESS_VALUE_RULE_SET_IS_PAUSED", +"UNTARGETABLE_GEO_TARGET", +"INVALID_AUDIENCE_USER_LIST", +"INACCESSIBLE_USER_LIST", +"INVALID_AUDIENCE_USER_INTEREST", +"CANNOT_ADD_RULE_WITH_STATUS_REMOVED", +"NO_DAY_OF_WEEK_SELECTED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The value rule's geo location condition contains invalid geo target constant(s), for example, there's no matching geo target.", +"The value rule's geo location condition contains conflicting included and excluded geo targets. Specifically, some of the excluded geo target(s) are the same as or contain some of the included geo target(s). For example, the geo location condition includes California but excludes U.S.", +"User specified conflicting conditions for two value rules in the same value rule set.", +"The value rule cannot be removed because it's still included in some value rule set.", +"The value rule contains a condition that's not allowed by the value rule set including this value rule.", +"The value rule contains a field that should be unset.", +"Pausing the value rule requires pausing the value rule set because the value rule is (one of) the last enabled in the value rule set.", +"The value rule's geo location condition contains untargetable geo target constant(s).", +"The value rule's audience condition contains invalid user list(s). In another word, there's no matching user list.", +"The value rule's audience condition contains inaccessible user list(s).", +"The value rule's audience condition contains invalid user_interest(s). This might be because there is no matching user interest, or the user interest is not visible.", +"When a value rule is created, it shouldn't have REMOVED status.", +"The value rule's itinerary condition contains invalid travel start day, it contains no day of week." +], +"type": "string" +}, +"conversionValueRuleSetError": { +"description": "The reasons for the conversion value rule set error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CONFLICTING_VALUE_RULE_CONDITIONS", +"INVALID_VALUE_RULE", +"DIMENSIONS_UPDATE_ONLY_ALLOW_APPEND", +"CONDITION_TYPE_NOT_ALLOWED", +"DUPLICATE_DIMENSIONS", +"INVALID_CAMPAIGN_ID", +"CANNOT_PAUSE_UNLESS_ALL_VALUE_RULES_ARE_PAUSED", +"SHOULD_PAUSE_WHEN_ALL_VALUE_RULES_ARE_PAUSED", +"VALUE_RULES_NOT_SUPPORTED_FOR_CAMPAIGN_TYPE", +"INELIGIBLE_CONVERSION_ACTION_CATEGORIES", +"DIMENSION_NO_CONDITION_USED_WITH_OTHER_DIMENSIONS", +"DIMENSION_NO_CONDITION_NOT_ALLOWED", +"UNSUPPORTED_CONVERSION_ACTION_CATEGORIES", +"DIMENSION_NOT_SUPPORTED_FOR_CAMPAIGN_TYPE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Two value rules in this value rule set contain conflicting conditions.", +"This value rule set includes a value rule that cannot be found, has been permanently removed or belongs to a different customer.", +"An error that's thrown when a mutate operation is trying to replace/remove some existing elements in the dimensions field. In other words, ADD op is always fine and UPDATE op is fine if it's only appending new elements into dimensions list.", +"An error that's thrown when a mutate is adding new value rule(s) into a value rule set and the added value rule(s) include conditions that are not specified in the dimensions of the value rule set.", +"The dimensions field contains duplicate elements.", +"This value rule set is attached to an invalid campaign id. Either a campaign with this campaign id doesn't exist or it belongs to a different customer.", +"When a mutate request tries to pause a value rule set, the enabled value rules in this set must be paused in the same command, or this error will be thrown.", +"When a mutate request tries to pause all the value rules in a value rule set, the value rule set must be paused, or this error will be thrown.", +"This value rule set is attached to a campaign that does not support value rules. Currently, campaign level value rule sets can only be created on Search, or Display campaigns.", +"To add a value rule set that applies on Store Visits/Store Sales conversion action categories, the customer must have valid Store Visits/ Store Sales conversion actions.", +"If NO_CONDITION is used as a dimension of a value rule set, it must be the only dimension.", +"Dimension NO_CONDITION can only be used by Store Visits/Store Sales value rule set.", +"Value rule sets defined on the specified conversion action categories are not supported. The list of conversion action categories must be an empty list, only STORE_VISIT, or only STORE_SALE.", +"Dimension ITINERARY can only be used on campaigns with an advertising channel type of PERFORMANCE_MAX or HOTEL." +], +"type": "string" +}, +"countryCodeError": { +"description": "The reasons for the country code error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_COUNTRY_CODE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The country code is invalid." +], +"type": "string" +}, +"criterionError": { +"description": "The reasons for the criterion error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CONCRETE_TYPE_REQUIRED", +"INVALID_EXCLUDED_CATEGORY", +"INVALID_KEYWORD_TEXT", +"KEYWORD_TEXT_TOO_LONG", +"KEYWORD_HAS_TOO_MANY_WORDS", +"KEYWORD_HAS_INVALID_CHARS", +"INVALID_PLACEMENT_URL", +"INVALID_USER_LIST", +"INVALID_USER_INTEREST", +"INVALID_FORMAT_FOR_PLACEMENT_URL", +"PLACEMENT_URL_IS_TOO_LONG", +"PLACEMENT_URL_HAS_ILLEGAL_CHAR", +"PLACEMENT_URL_HAS_MULTIPLE_SITES_IN_LINE", +"PLACEMENT_IS_NOT_AVAILABLE_FOR_TARGETING_OR_EXCLUSION", +"INVALID_TOPIC_PATH", +"INVALID_YOUTUBE_CHANNEL_ID", +"INVALID_YOUTUBE_VIDEO_ID", +"YOUTUBE_VERTICAL_CHANNEL_DEPRECATED", +"YOUTUBE_DEMOGRAPHIC_CHANNEL_DEPRECATED", +"YOUTUBE_URL_UNSUPPORTED", +"CANNOT_EXCLUDE_CRITERIA_TYPE", +"CANNOT_ADD_CRITERIA_TYPE", +"CANNOT_EXCLUDE_SIMILAR_USER_LIST", +"CANNOT_ADD_CLOSED_USER_LIST", +"CANNOT_ADD_DISPLAY_ONLY_LISTS_TO_SEARCH_ONLY_CAMPAIGNS", +"CANNOT_ADD_DISPLAY_ONLY_LISTS_TO_SEARCH_CAMPAIGNS", +"CANNOT_ADD_DISPLAY_ONLY_LISTS_TO_SHOPPING_CAMPAIGNS", +"CANNOT_ADD_USER_INTERESTS_TO_SEARCH_CAMPAIGNS", +"CANNOT_SET_BIDS_ON_CRITERION_TYPE_IN_SEARCH_CAMPAIGNS", +"CANNOT_ADD_URLS_TO_CRITERION_TYPE_FOR_CAMPAIGN_TYPE", +"INVALID_COMBINED_AUDIENCE", +"INVALID_CUSTOM_AFFINITY", +"INVALID_CUSTOM_INTENT", +"INVALID_CUSTOM_AUDIENCE", +"INVALID_IP_ADDRESS", +"INVALID_IP_FORMAT", +"INVALID_MOBILE_APP", +"INVALID_MOBILE_APP_CATEGORY", +"INVALID_CRITERION_ID", +"CANNOT_TARGET_CRITERION", +"CANNOT_TARGET_OBSOLETE_CRITERION", +"CRITERION_ID_AND_TYPE_MISMATCH", +"INVALID_PROXIMITY_RADIUS", +"INVALID_PROXIMITY_RADIUS_UNITS", +"INVALID_STREETADDRESS_LENGTH", +"INVALID_CITYNAME_LENGTH", +"INVALID_REGIONCODE_LENGTH", +"INVALID_REGIONNAME_LENGTH", +"INVALID_POSTALCODE_LENGTH", +"INVALID_COUNTRY_CODE", +"INVALID_LATITUDE", +"INVALID_LONGITUDE", +"PROXIMITY_GEOPOINT_AND_ADDRESS_BOTH_CANNOT_BE_NULL", +"INVALID_PROXIMITY_ADDRESS", +"INVALID_USER_DOMAIN_NAME", +"CRITERION_PARAMETER_TOO_LONG", +"AD_SCHEDULE_TIME_INTERVALS_OVERLAP", +"AD_SCHEDULE_INTERVAL_CANNOT_SPAN_MULTIPLE_DAYS", +"AD_SCHEDULE_INVALID_TIME_INTERVAL", +"AD_SCHEDULE_EXCEEDED_INTERVALS_PER_DAY_LIMIT", +"AD_SCHEDULE_CRITERION_ID_MISMATCHING_FIELDS", +"CANNOT_BID_MODIFY_CRITERION_TYPE", +"CANNOT_BID_MODIFY_CRITERION_CAMPAIGN_OPTED_OUT", +"CANNOT_BID_MODIFY_NEGATIVE_CRITERION", +"BID_MODIFIER_ALREADY_EXISTS", +"FEED_ID_NOT_ALLOWED", +"ACCOUNT_INELIGIBLE_FOR_CRITERIA_TYPE", +"CRITERIA_TYPE_INVALID_FOR_BIDDING_STRATEGY", +"CANNOT_EXCLUDE_CRITERION", +"CANNOT_REMOVE_CRITERION", +"INVALID_PRODUCT_BIDDING_CATEGORY", +"MISSING_SHOPPING_SETTING", +"INVALID_MATCHING_FUNCTION", +"LOCATION_FILTER_NOT_ALLOWED", +"INVALID_FEED_FOR_LOCATION_FILTER", +"LOCATION_FILTER_INVALID", +"CANNOT_SET_GEO_TARGET_CONSTANTS_WITH_FEED_ITEM_SETS", +"CANNOT_SET_BOTH_ASSET_SET_AND_FEED", +"CANNOT_SET_FEED_OR_FEED_ITEM_SETS_FOR_CUSTOMER", +"CANNOT_SET_ASSET_SET_FIELD_FOR_CUSTOMER", +"CANNOT_SET_GEO_TARGET_CONSTANTS_WITH_ASSET_SETS", +"CANNOT_SET_ASSET_SETS_WITH_FEED_ITEM_SETS", +"INVALID_LOCATION_GROUP_ASSET_SET", +"INVALID_LOCATION_GROUP_RADIUS", +"INVALID_LOCATION_GROUP_RADIUS_UNIT", +"CANNOT_ATTACH_CRITERIA_AT_CAMPAIGN_AND_ADGROUP", +"HOTEL_LENGTH_OF_STAY_OVERLAPS_WITH_EXISTING_CRITERION", +"HOTEL_ADVANCE_BOOKING_WINDOW_OVERLAPS_WITH_EXISTING_CRITERION", +"FIELD_INCOMPATIBLE_WITH_NEGATIVE_TARGETING", +"INVALID_WEBPAGE_CONDITION", +"INVALID_WEBPAGE_CONDITION_URL", +"WEBPAGE_CONDITION_URL_CANNOT_BE_EMPTY", +"WEBPAGE_CONDITION_URL_UNSUPPORTED_PROTOCOL", +"WEBPAGE_CONDITION_URL_CANNOT_BE_IP_ADDRESS", +"WEBPAGE_CONDITION_URL_DOMAIN_NOT_CONSISTENT_WITH_CAMPAIGN_SETTING", +"WEBPAGE_CONDITION_URL_CANNOT_BE_PUBLIC_SUFFIX", +"WEBPAGE_CONDITION_URL_INVALID_PUBLIC_SUFFIX", +"WEBPAGE_CONDITION_URL_VALUE_TRACK_VALUE_NOT_SUPPORTED", +"WEBPAGE_CRITERION_URL_EQUALS_CAN_HAVE_ONLY_ONE_CONDITION", +"WEBPAGE_CRITERION_NOT_SUPPORTED_ON_NON_DSA_AD_GROUP", +"CANNOT_TARGET_USER_LIST_FOR_SMART_DISPLAY_CAMPAIGNS", +"CANNOT_TARGET_PLACEMENTS_FOR_SEARCH_CAMPAIGNS", +"LISTING_SCOPE_TOO_MANY_DIMENSION_TYPES", +"LISTING_SCOPE_TOO_MANY_IN_OPERATORS", +"LISTING_SCOPE_IN_OPERATOR_NOT_SUPPORTED", +"DUPLICATE_LISTING_DIMENSION_TYPE", +"DUPLICATE_LISTING_DIMENSION_VALUE", +"CANNOT_SET_BIDS_ON_LISTING_GROUP_SUBDIVISION", +"LISTING_GROUP_ERROR_IN_ANOTHER_OPERATION", +"INVALID_LISTING_GROUP_HIERARCHY", +"LISTING_GROUP_TREE_WAS_INVALID_BEFORE_MUTATION", +"LISTING_GROUP_UNIT_CANNOT_HAVE_CHILDREN", +"LISTING_GROUP_SUBDIVISION_REQUIRES_OTHERS_CASE", +"LISTING_GROUP_REQUIRES_SAME_DIMENSION_TYPE_AS_SIBLINGS", +"LISTING_GROUP_ALREADY_EXISTS", +"LISTING_GROUP_DOES_NOT_EXIST", +"LISTING_GROUP_CANNOT_BE_REMOVED", +"INVALID_LISTING_GROUP_TYPE", +"LISTING_GROUP_ADD_MAY_ONLY_USE_TEMP_ID", +"LISTING_SCOPE_TOO_LONG", +"LISTING_SCOPE_TOO_MANY_DIMENSIONS", +"LISTING_GROUP_TOO_LONG", +"LISTING_GROUP_TREE_TOO_DEEP", +"INVALID_LISTING_DIMENSION", +"INVALID_LISTING_DIMENSION_TYPE", +"ADVERTISER_NOT_ON_ALLOWLIST_FOR_COMBINED_AUDIENCE_ON_DISPLAY", +"CANNOT_TARGET_REMOVED_COMBINED_AUDIENCE", +"INVALID_COMBINED_AUDIENCE_ID", +"CANNOT_TARGET_REMOVED_CUSTOM_AUDIENCE", +"HOTEL_CHECK_IN_DATE_RANGE_OVERLAPS_WITH_EXISTING_CRITERION", +"HOTEL_CHECK_IN_DATE_RANGE_START_DATE_TOO_EARLY", +"HOTEL_CHECK_IN_DATE_RANGE_END_DATE_TOO_LATE", +"HOTEL_CHECK_IN_DATE_RANGE_REVERSED", +"BROAD_MATCH_MODIFIER_KEYWORD_NOT_ALLOWED", +"ONE_AUDIENCE_ALLOWED_PER_ASSET_GROUP", +"AUDIENCE_NOT_ELIGIBLE_FOR_CAMPAIGN_TYPE", +"AUDIENCE_NOT_ALLOWED_TO_ATTACH_WHEN_AUDIENCE_GROUPED_SET_TO_FALSE", +"CANNOT_TARGET_CUSTOMER_MATCH_USER_LIST", +"NEGATIVE_KEYWORD_SHARED_SET_DOES_NOT_EXIST", +"CANNOT_ADD_REMOVED_NEGATIVE_KEYWORD_SHARED_SET", +"CANNOT_HAVE_MULTIPLE_NEGATIVE_KEYWORD_LIST_PER_ACCOUNT", +"CUSTOMER_CANNOT_ADD_CRITERION_OF_THIS_TYPE", +"CANNOT_TARGET_SIMILAR_USER_LIST", +"CANNOT_ADD_AUDIENCE_SEGMENT_CRITERION_WHEN_AUDIENCE_GROUPED_IS_SET", +"ONE_AUDIENCE_ALLOWED_PER_AD_GROUP", +"INVALID_DETAILED_DEMOGRAPHIC", +"CANNOT_RECOGNIZE_BRAND", +"BRAND_SHARED_SET_DOES_NOT_EXIST", +"CANNOT_ADD_REMOVED_BRAND_SHARED_SET", +"ONLY_EXCLUSION_BRAND_LIST_ALLOWED_FOR_CAMPAIGN_TYPE", +"LOCATION_TARGETING_NOT_ELIGIBLE_FOR_RESTRICTED_CAMPAIGN", +"ONLY_INCLUSION_BRAND_LIST_ALLOWED_FOR_AD_GROUPS", +"CANNOT_ADD_REMOVED_PLACEMENT_LIST_SHARED_SET", +"PLACEMENT_LIST_SHARED_SET_DOES_NOT_EXIST", +"AI_MAX_MUST_BE_ENABLED", +"NOT_AVAILABLE_FOR_AI_MAX_CAMPAIGNS", +"MISSING_EU_POLITICAL_ADVERTISING_SELF_DECLARATION", +"INVALID_CAMPAIGN_TYPE_FOR_THIRD_PARTY_PARTNER_DATA_LIST", +"CANNOT_ADD_USER_LIST_PENDING_PRIVACY_REVIEW", +"VERTICAL_ADS_ITEM_GROUP_RULE_LIST_DOES_NOT_EXIST", +"CANNOT_ADD_REMOVED_VERTICAL_ADS_ITEM_GROUP_RULE_LIST_SHARED_SET", +"VERTICAL_ADS_ITEM_GROUP_RULE_LIST_NOT_SUPPORTED_FOR_CAMPAIGNS_WITHOUT_ENABLED_TRAVEL_FEED", +"VERTICAL_ADS_ITEM_GROUP_RULE_LIST_NOT_SUPPORTED_FOR_CAMPAIGNS_WITHOUT_AI_MAX", +"VERTICAL_ADS_ITEM_GROUP_RULE_NOT_SUPPORTED_FOR_THE_VERTICAL_TYPE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Concrete type of criterion is required for CREATE and UPDATE operations.", +"The category requested for exclusion is invalid.", +"Invalid keyword criteria text.", +"Keyword text should be less than 80 chars.", +"Keyword text has too many words.", +"Keyword text has invalid characters or symbols.", +"Invalid placement URL.", +"Invalid user list criterion.", +"Invalid user interest criterion.", +"Placement URL has wrong format.", +"Placement URL is too long.", +"Indicates the URL contains an illegal character.", +"Indicates the URL contains multiple comma separated URLs.", +"Indicates the domain is blocked.", +"Invalid topic path.", +"The YouTube Channel Id is invalid.", +"The YouTube Video Id is invalid.", +"Indicates the placement is a YouTube vertical channel, which is no longer supported.", +"Indicates the placement is a YouTube demographic channel, which is no longer supported.", +"YouTube urls are not supported in Placement criterion. Use YouTubeChannel and YouTubeVideo criterion instead.", +"Criteria type can not be excluded by the customer, like AOL account type cannot target site type criteria.", +"Criteria type can not be targeted.", +"Not allowed to exclude similar user list.", +"Not allowed to target a closed user list.", +"Not allowed to add display only UserLists to search only campaigns.", +"Not allowed to add display only UserLists to search plus campaigns.", +"Not allowed to add display only UserLists to shopping campaigns.", +"Not allowed to add User interests to search only campaigns.", +"Not allowed to set bids for this criterion type in search campaigns", +"Final URLs, URL Templates and CustomParameters cannot be set for the criterion types of Gender, AgeRange, UserList, Placement, MobileApp, and MobileAppCategory in search campaigns and shopping campaigns.", +"Invalid combined audience criterion.", +"Invalid custom affinity criterion.", +"Invalid custom intent criterion.", +"Invalid custom audience criterion.", +"IP address is not valid.", +"IP format is not valid.", +"Mobile application is not valid.", +"Mobile application category is not valid.", +"The CriterionId does not exist or is of the incorrect type.", +"The Criterion is not allowed to be targeted.", +"The criterion is not allowed to be targeted as it is deprecated.", +"The CriterionId is not valid for the type.", +"Distance for the radius for the proximity criterion is invalid.", +"Units for the distance for the radius for the proximity criterion is invalid.", +"Street address in the address is not valid.", +"City name in the address is not valid.", +"Region code in the address is not valid.", +"Region name in the address is not valid.", +"Postal code in the address is not valid.", +"Country code in the address is not valid.", +"Latitude for the GeoPoint is not valid.", +"Longitude for the GeoPoint is not valid.", +"The Proximity input is not valid. Both address and geoPoint cannot be null.", +"The Proximity address cannot be geocoded to a valid lat/long.", +"User domain name is not valid.", +"Length of serialized criterion parameter exceeded size limit.", +"Time interval in the AdSchedule overlaps with another AdSchedule.", +"AdSchedule time interval cannot span multiple days.", +"AdSchedule time interval specified is invalid, endTime cannot be earlier than startTime.", +"The number of AdSchedule entries in a day exceeds the limit.", +"CriteriaId does not match the interval of the AdSchedule specified.", +"Cannot set bid modifier for this criterion type.", +"Cannot bid modify criterion, since it is opted out of the campaign.", +"Cannot set bid modifier for a negative criterion.", +"Bid Modifier already exists. Use SET operation to update.", +"Feed Id is not allowed in these Location Groups.", +"The account may not use the requested criteria type. For example, some accounts are restricted to keywords only.", +"The requested criteria type cannot be used with campaign or ad group bidding strategy.", +"The Criterion is not allowed to be excluded.", +"The criterion is not allowed to be removed. For example, we cannot remove any of the device criterion.", +"Bidding categories do not form a valid path in the Shopping bidding category taxonomy.", +"ShoppingSetting must be added to the campaign before ProductScope criteria can be added.", +"Matching function is invalid.", +"Filter parameters not allowed for location groups targeting.", +"Feed not found, or the feed is not an enabled location feed.", +"Given location filter parameter is invalid for location groups targeting.", +"Cannot set geo target constants and feed item sets at the same time.", +"Cannot set both assetset and feed at the same time.", +"Cannot set feed or feed item sets for Customer.", +"Cannot set AssetSet criteria for customer.", +"Cannot set geo target constants and asset sets at the same time.", +"Cannot set asset sets and feed item sets at the same time.", +"The location group asset set id is invalid", +"The location group radius is in the range but not at the valid increment.", +"The location group radius unit is invalid.", +"Criteria type cannot be associated with a campaign and its ad group(s) simultaneously.", +"Range represented by hotel length of stay's min nights and max nights overlaps with an existing criterion.", +"Range represented by hotel advance booking window's min days and max days overlaps with an existing criterion.", +"The field is not allowed to be set when the negative field is set to true, for example, we don't allow bids in negative ad group or campaign criteria.", +"The combination of operand and operator in webpage condition is invalid.", +"The URL of webpage condition is invalid.", +"The URL of webpage condition cannot be empty or contain white space.", +"The URL of webpage condition contains an unsupported protocol.", +"The URL of webpage condition cannot be an IP address.", +"The domain of the URL is not consistent with the domain in campaign setting.", +"The URL of webpage condition cannot be a public suffix itself.", +"The URL of webpage condition has an invalid public suffix.", +"Value track parameter is not supported in webpage condition URL.", +"Only one URL-EQUALS webpage condition is allowed in a webpage criterion and it cannot be combined with other conditions.", +"A webpage criterion cannot be added to a non-DSA ad group.", +"Cannot add positive user list criteria in Smart Display campaigns.", +"Cannot add positive placement criterion types in search campaigns.", +"Listing scope contains too many dimension types.", +"Listing scope has too many IN operators.", +"Listing scope contains IN operator on an unsupported dimension type.", +"There are dimensions with duplicate dimension type.", +"There are dimensions with duplicate dimension value.", +"Listing group SUBDIVISION nodes cannot have bids.", +"Product group operation is invalid because another operation targeting the same AdGroupId is failing.", +"Ad group is invalid due to the listing groups it contains.", +"Tree was invalid before the mutation.", +"Listing group unit cannot have children.", +"Subdivided listing groups must have an \"others\" case.", +"Dimension type of listing group must be the same as that of its siblings.", +"Listing group cannot be added to the ad group because it already exists.", +"Listing group referenced in the operation was not found in the ad group.", +"Recursive removal failed because listing group subdivision is being created or modified in this request.", +"Listing group type is not allowed for specified ad group criterion type.", +"Listing group in an ADD operation specifies a non temporary criterion id.", +"The combined length of dimension values of the Listing scope criterion is too long.", +"Listing scope contains too many dimensions.", +"The combined length of dimension values of the Listing group criterion is too long.", +"Listing group tree is too deep.", +"Listing dimension is invalid (for example, dimension contains illegal value, dimension type is represented with wrong class, etc). Listing dimension value can not contain \"==\" or \"&+\".", +"Listing dimension type is either invalid for campaigns of this type or cannot be used in the current context. BIDDING_CATEGORY_Lx and PRODUCT_TYPE_Lx dimensions must be used in ascending order of their levels: L1, L2, L3, L4, L5... The levels must be specified sequentially and start from L1. Furthermore, an \"others\" Listing group cannot be subdivided with a dimension of the same type but of a higher level (\"others\" BIDDING_CATEGORY_L3 can be subdivided with BRAND but not with BIDDING_CATEGORY_L4).", +"Customer is not on allowlist for composite audience in display campaigns.", +"Cannot target on a removed combined audience.", +"Combined audience ID is invalid.", +"Can not target removed combined audience.", +"Range represented by hotel check-in date's start date and end date overlaps with an existing criterion.", +"Start date is earlier than earliest allowed value of yesterday UTC.", +"End date later is than latest allowed day of 330 days in the future UTC.", +"Start date is after end date.", +"Broad match modifier (BMM) keywords can no longer be created. See https://ads-developers.googleblog.com/2021/06/broad-match-modifier-upcoming-changes.html.", +"Only one audience is allowed in an asset group.", +"Audience is not supported for the specified campaign type.", +"Audience is not allowed to attach when use_audience_grouped bit is set to false.", +"Targeting is not allowed for Customer Match lists as per Customer Match policy. See https://support.google.com/google-ads/answer/6299717.", +"Cannot create a negative keyword list criterion with a shared set that does not exist.", +"Cannot create a negative keyword list with deleted shared set.", +"Can only have one Negative Keyword List per account.", +"Only allowlisted customers can add criteria of this type.", +"Targeting for Similar audiences is not supported, since this feature has been deprecated. See https://support.google.com/google-ads/answer/12463119 to learn more.", +"Audience segment criteria cannot be added when use_audience_grouped bit is set.", +"Only one audience is allowed in an ad group.", +"Invalid detailed demographics criterion.", +"The brand criteria has a brand input that is not recognized as a valid brand.", +"The brand_list.shared_set_id references a shared set that does not exist.", +"Cannot create a brand list with deleted shared set.", +"Brand list can only be negatively targeted for the campaign type.", +"Cannot positively target locations outside of restricted area for campaign.", +"Ad group level brand list criteria only support inclusionary targeting. Negative targeting at this level is not supported.", +"Cannot create a placement list with deleted shared set.", +"The placement_list.shared_set_id references a shared set that does not exist.", +"This feature is only available for AI Max campaigns.", +"This feature is not available for AI Max campaigns.", +"The operation failed because the campaign is missing the self-declaration on political advertising status in the EU.", +"Targeting this UserList is not allowed for this campaign type.", +"The user list cannot be used while it is pending privacy review.", +"The referenced Vertical Ads item group rule list shared set does not exist.", +"Cannot add Vertical Ads Item Group Rule List with deleted shared set.", +"Vertical Ads Item Group Rule List is not supported for campaigns that do not have an active travel feed.", +"Vertical Ads Item Group Rule List is not supported for campaigns that do not have AI max enabled.", +"The dimension of the Vertical Ads Item Group Rule criterion is not supported for the shared set vertical type." +], +"type": "string" +}, +"currencyCodeError": { +"description": "The reasons for the currency code error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"UNSUPPORTED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The currency code is not supported." +], +"type": "string" +}, +"currencyError": { +"description": "The reasons for the currency errors.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"VALUE_NOT_MULTIPLE_OF_BILLABLE_UNIT" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Bid must be a multiple of billable unit." +], +"type": "string" +}, +"customAudienceError": { +"description": "The reasons for the custom audience error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"NAME_ALREADY_USED", +"CANNOT_REMOVE_WHILE_IN_USE", +"RESOURCE_ALREADY_REMOVED", +"MEMBER_TYPE_AND_PARAMETER_ALREADY_EXISTED", +"INVALID_MEMBER_TYPE", +"MEMBER_TYPE_AND_VALUE_DOES_NOT_MATCH", +"POLICY_VIOLATION", +"INVALID_TYPE_CHANGE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"New name in the custom audience is duplicated ignoring cases.", +"Cannot remove a custom audience while it's still being used as targeting.", +"Cannot update or remove a custom audience that is already removed.", +"The pair of [type, value] already exists in members.", +"Member type is invalid.", +"Member type does not have associated value.", +"Custom audience contains a member that violates policy.", +"Change in custom audience type is not allowed." +], +"type": "string" +}, +"customColumnError": { +"description": "The reasons for the custom column error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CUSTOM_COLUMN_NOT_FOUND", +"CUSTOM_COLUMN_NOT_AVAILABLE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The custom column has not been found.", +"The custom column is not available." +], +"type": "string" +}, +"customConversionGoalError": { +"description": "The reasons for the custom conversion goal error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_CONVERSION_ACTION", +"CONVERSION_ACTION_NOT_ENABLED", +"CANNOT_REMOVE_LINKED_CUSTOM_CONVERSION_GOAL", +"CUSTOM_GOAL_DUPLICATE_NAME", +"DUPLICATE_CONVERSION_ACTION_LIST", +"NON_BIDDABLE_CONVERSION_ACTION_NOT_ELIGIBLE_FOR_CUSTOM_GOAL" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Cannot find a conversion action with the specified id.", +"The conversion action is not enabled so it cannot be included in a custom conversion goal.", +"The custom conversion goal cannot be removed because it's linked to a campaign.", +"Custom goal with the same name already exists.", +"Custom goal with the same conversion action list already exists.", +"Conversion types that cannot be biddable should not be included in custom goal." +], +"type": "string" +}, +"customInterestError": { +"description": "The reasons for the custom interest error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"NAME_ALREADY_USED", +"CUSTOM_INTEREST_MEMBER_ID_AND_TYPE_PARAMETER_NOT_PRESENT_IN_REMOVE", +"TYPE_AND_PARAMETER_NOT_FOUND", +"TYPE_AND_PARAMETER_ALREADY_EXISTED", +"INVALID_CUSTOM_INTEREST_MEMBER_TYPE", +"CANNOT_REMOVE_WHILE_IN_USE", +"CANNOT_CHANGE_TYPE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Duplicate custom interest name ignoring case.", +"In the remove custom interest member operation, both member ID and pair [type, parameter] are not present.", +"The pair of [type, parameter] does not exist.", +"The pair of [type, parameter] already exists.", +"Unsupported custom interest member type.", +"Cannot remove a custom interest while it's still being targeted.", +"Cannot mutate custom interest type." +], +"type": "string" +}, +"customerClientLinkError": { +"description": "The reasons for the customer client link error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CLIENT_ALREADY_INVITED_BY_THIS_MANAGER", +"CLIENT_ALREADY_MANAGED_IN_HIERARCHY", +"CYCLIC_LINK_NOT_ALLOWED", +"CUSTOMER_HAS_TOO_MANY_ACCOUNTS", +"CLIENT_HAS_TOO_MANY_INVITATIONS", +"CANNOT_HIDE_OR_UNHIDE_MANAGER_ACCOUNTS", +"CUSTOMER_HAS_TOO_MANY_ACCOUNTS_AT_MANAGER", +"CLIENT_HAS_TOO_MANY_MANAGERS" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Trying to manage a client that already in being managed by customer.", +"Already managed by some other manager in the hierarchy.", +"Attempt to create a cycle in the hierarchy.", +"Managed accounts has the maximum number of linked accounts.", +"Invitor has the maximum pending invitations.", +"Attempt to change hidden status of a link that is not active.", +"Parent manager account has the maximum number of linked accounts.", +"Client has too many managers." +], +"type": "string" +}, +"customerCustomizerError": { +"description": "The reasons for the customer customizer error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version." +], +"type": "string" +}, +"customerError": { +"description": "The reasons for the customer error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"STATUS_CHANGE_DISALLOWED", +"ACCOUNT_NOT_SET_UP", +"CREATION_DENIED_FOR_POLICY_VIOLATION", +"CREATION_DENIED_INELIGIBLE_MCC" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Customer status is not allowed to be changed from DRAFT and CLOSED. Currency code and at least one of country code and time zone needs to be set when status is changed to ENABLED.", +"CustomerService cannot get a customer that has not been fully set up.", +"Customer creation is denied for policy violation.", +"Manager account is ineligible to create new accounts." +], +"type": "string" +}, +"customerFeedError": { +"description": "The reasons for the customer feed error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"FEED_ALREADY_EXISTS_FOR_PLACEHOLDER_TYPE", +"CANNOT_CREATE_FOR_REMOVED_FEED", +"CANNOT_CREATE_ALREADY_EXISTING_CUSTOMER_FEED", +"CANNOT_MODIFY_REMOVED_CUSTOMER_FEED", +"INVALID_PLACEHOLDER_TYPE", +"MISSING_FEEDMAPPING_FOR_PLACEHOLDER_TYPE", +"PLACEHOLDER_TYPE_NOT_ALLOWED_ON_CUSTOMER_FEED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"An active feed already exists for this customer and place holder type.", +"The specified feed is removed.", +"The CustomerFeed already exists. Update should be used to modify the existing CustomerFeed.", +"Cannot update removed customer feed.", +"Invalid placeholder type.", +"Feed mapping for this placeholder type does not exist.", +"Placeholder not allowed at the account level." +], +"type": "string" +}, +"customerLifecycleGoalError": { +"description": "The reasons for the customer lifecycle goal error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CUSTOMER_ACQUISITION_VALUE_MISSING", +"CUSTOMER_ACQUISITION_INVALID_VALUE", +"CUSTOMER_ACQUISITION_INVALID_HIGH_LIFETIME_VALUE", +"CUSTOMER_ACQUISITION_VALUE_CANNOT_BE_CLEARED", +"CUSTOMER_ACQUISITION_HIGH_LIFETIME_VALUE_CANNOT_BE_CLEARED", +"INVALID_EXISTING_USER_LIST", +"INVALID_HIGH_LIFETIME_VALUE_USER_LIST" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"CustomerLifecycleGoal.customer_acquisition_goal_value_settings.value must be set.", +"CustomerLifecycleGoal.customer_acquisition_goal_value_settings.value must be no less than 0.01.", +"CustomerLifecycleGoal.customer_acquisition_goal_value_settings.high_lifetime_value must be no less than 0.01. Also, to set this field, CustomerLifecycleGoal.customer_acquisition_goal_value_settings.value must also be present, and high_lifetime_value must be greater than value.", +"CustomerLifecycleGoal.customer_acquisition_goal_value_settings.value cannot be cleared. This value would have no effect as long as none of your campaigns adopt the customer acquisitiong goal.", +"CustomerLifecycleGoal.customer_acquisition_goal_value_settings.high_lifetime_value cannot be cleared. This value would have no effect as long as none of your campaigns adopt the high value optimization of customer acquisitiong goal.", +"Found invalid value in CustomerLifecycleGoal.lifecycle_goal_customer_definition_settings.existing_user_lists. The userlist must be accessible, active and belong to one of the following types: CRM_BASED, RULE_BASED, REMARKETING.", +"Found invalid value in CustomerLifecycleGoal.lifecycle_goal_customer_definition_settings.high_lifetime_value_user_lists. The userlist must be accessible, active and belong to one of the following types: CRM_BASED, RULE_BASED, REMARKETING." +], +"type": "string" +}, +"customerManagerLinkError": { +"description": "The reasons for the customer manager link error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"NO_PENDING_INVITE", +"SAME_CLIENT_MORE_THAN_ONCE_PER_CALL", +"MANAGER_HAS_MAX_NUMBER_OF_LINKED_ACCOUNTS", +"CANNOT_UNLINK_ACCOUNT_WITHOUT_ACTIVE_USER", +"CANNOT_REMOVE_LAST_CLIENT_ACCOUNT_OWNER", +"CANNOT_CHANGE_ROLE_BY_NON_ACCOUNT_OWNER", +"CANNOT_CHANGE_ROLE_FOR_NON_ACTIVE_LINK_ACCOUNT", +"DUPLICATE_CHILD_FOUND", +"TEST_ACCOUNT_LINKS_TOO_MANY_CHILD_ACCOUNTS" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"No pending invitation.", +"Attempt to operate on the same client more than once in the same call.", +"Manager account has the maximum number of linked accounts.", +"If no active user on account it cannot be unlinked from its manager.", +"Account should have at least one active owner on it before being unlinked.", +"Only account owners may change their permission role.", +"When a client's link to its manager is not active, the link role cannot be changed.", +"Attempt to link a child to a parent that contains or will contain duplicate children.", +"The authorized customer is a test account. It can add no more than the allowed number of accounts" +], +"type": "string" +}, +"customerSkAdNetworkConversionValueSchemaError": { +"description": "The reasons for the customer SK Ad network conversion value schema error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_LINK_ID", +"INVALID_APP_ID", +"INVALID_SCHEMA", +"LINK_CODE_NOT_FOUND", +"INVALID_EVENT_COUNTER", +"INVALID_EVENT_NAME" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The customer link ID provided is invalid.", +"The app ID provided is invalid.", +"The conversion value schema provided is invalid.", +"The customer link id provided could not be found.", +"The SkAdNetwork event counter provided is invalid.", +"The SkAdNetwork event name provided is invalid." +], +"type": "string" +}, +"customerUserAccessError": { +"description": "The reasons for the customer user access mutate error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_USER_ID", +"REMOVAL_DISALLOWED", +"DISALLOWED_ACCESS_ROLE", +"LAST_ADMIN_USER_OF_SERVING_CUSTOMER", +"LAST_ADMIN_USER_OF_MANAGER" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"There is no user associated with the user id specified.", +"Unable to remove the access between the user and customer.", +"Unable to add or update the access role as specified.", +"The user can't remove itself from an active serving customer if it's the last admin user and the customer doesn't have any owner manager", +"Last admin user cannot be removed from a manager." +], +"type": "string" +}, +"customizerAttributeError": { +"description": "The reasons for the customizer attribute error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"DUPLICATE_CUSTOMIZER_ATTRIBUTE_NAME" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"CustomizerAttribute name matches that of another active CustomizerAttribute." +], +"type": "string" +}, +"dataLinkError": { +"description": "The reasons for the data link error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"YOUTUBE_CHANNEL_ID_INVALID", +"YOUTUBE_VIDEO_ID_INVALID", +"YOUTUBE_VIDEO_FROM_DIFFERENT_CHANNEL", +"PERMISSION_DENIED", +"INVALID_STATUS", +"INVALID_UPDATE_STATUS", +"INVALID_RESOURCE_NAME" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The requested YouTube Channel ID is invalid.", +"The requested YouTube Video ID is invalid.", +"The requested YouTube Video ID doesn't belong to the requested YouTube Channel ID.", +"A link cannot be created because the customer doesn't have the permission.", +"A link can not be removed or updated because the status is invalid.", +"The input status in the update request is invalid.", +"The input resource name is invalid." +], +"type": "string" +}, +"databaseError": { +"description": "The reasons for the database error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CONCURRENT_MODIFICATION", +"DATA_CONSTRAINT_VIOLATION", +"REQUEST_TOO_LARGE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Multiple requests were attempting to modify the same resource at once. Retry the request.", +"The request conflicted with existing data. This error will usually be replaced with a more specific error if the request is retried.", +"The data written is too large. Split the request into smaller requests." +], +"type": "string" +}, +"dateError": { +"description": "The reasons for the date error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_FIELD_VALUES_IN_DATE", +"INVALID_FIELD_VALUES_IN_DATE_TIME", +"INVALID_STRING_DATE", +"INVALID_STRING_DATE_TIME_MICROS", +"INVALID_STRING_DATE_TIME_SECONDS", +"INVALID_STRING_DATE_TIME_SECONDS_WITH_OFFSET", +"EARLIER_THAN_MINIMUM_DATE", +"LATER_THAN_MAXIMUM_DATE", +"DATE_RANGE_MINIMUM_DATE_LATER_THAN_MAXIMUM_DATE", +"DATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL", +"DATE_RANGE_ERROR_START_TIME_MUST_BE_THE_START_OF_A_DAY", +"DATE_RANGE_ERROR_END_TIME_MUST_BE_THE_END_OF_A_DAY" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Given field values do not correspond to a valid date.", +"Given field values do not correspond to a valid date time.", +"The string date's format should be yyyy-mm-dd.", +"The string date time's format should be yyyy-mm-dd hh:mm:ss.ssssss.", +"The string date time's format should be yyyy-mm-dd hh:mm:ss.", +"The string date time's format should be yyyy-mm-dd hh:mm:ss+|-hh:mm.", +"Date is before allowed minimum.", +"Date is after allowed maximum.", +"Date range bounds are not in order.", +"Both dates in range are null.", +"This campaign type doesn't support a start date time that isn't the start of the day.", +"This campaign type doesn't support an end date time that isn't the end of the day." +], +"type": "string" +}, +"dateRangeError": { +"description": "The reasons for the date range error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_DATE", +"START_DATE_AFTER_END_DATE", +"CANNOT_SET_DATE_TO_PAST", +"AFTER_MAXIMUM_ALLOWABLE_DATE", +"CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Invalid date.", +"The start date was after the end date.", +"Cannot set date to past time", +"A date was used that is past the system \"last\" date.", +"Trying to change start date on a resource that has started." +], +"type": "string" +}, +"distinctError": { +"description": "The reasons for the distinct error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"DUPLICATE_ELEMENT", +"DUPLICATE_TYPE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Duplicate element.", +"Duplicate type." +], +"type": "string" +}, +"enumError": { +"description": "The reason for enum error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"ENUM_VALUE_NOT_PERMITTED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The enum value is not permitted." +], +"type": "string" +}, +"experimentArmError": { +"description": "The reasons for the experiment arm error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"EXPERIMENT_ARM_COUNT_LIMIT_EXCEEDED", +"INVALID_CAMPAIGN_STATUS", +"DUPLICATE_EXPERIMENT_ARM_NAME", +"CANNOT_SET_TREATMENT_ARM_CAMPAIGN", +"CANNOT_MODIFY_CAMPAIGN_IDS", +"CANNOT_MODIFY_CAMPAIGN_WITHOUT_SUFFIX_SET", +"CANNOT_MUTATE_TRAFFIC_SPLIT_AFTER_START", +"CANNOT_ADD_CAMPAIGN_WITH_SHARED_BUDGET", +"CANNOT_ADD_CAMPAIGN_WITH_CUSTOM_BUDGET", +"CANNOT_ADD_CAMPAIGNS_WITH_DYNAMIC_ASSETS_ENABLED", +"UNSUPPORTED_CAMPAIGN_ADVERTISING_CHANNEL_SUB_TYPE", +"CANNOT_ADD_BASE_CAMPAIGN_WITH_DATE_RANGE", +"BIDDING_STRATEGY_NOT_SUPPORTED_IN_EXPERIMENTS", +"TRAFFIC_SPLIT_NOT_SUPPORTED_FOR_CHANNEL_TYPE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Number of experiment arms is above limit.", +"Cannot add campaign with invalid status to the experiment arm.", +"Cannot add duplicate experiment arm name in one experiment.", +"Cannot set campaigns of treatment experiment arm.", +"Cannot edit campaign ids in trial arms in non SETUP experiment.", +"Cannot modify the campaigns in the control arm if there is not a suffix set in the trial.", +"Traffic split related settings (like traffic share bounds) can't be modified after the trial has started.", +"Cannot use shared budget on experiment's control campaign.", +"Cannot use custom budget on experiment's control campaigns.", +"Cannot have enable_dynamic_assets turned on in experiment's campaigns.", +"Cannot use campaign's advertising channel sub type in experiment.", +"Experiment date range must be within base campaign's date range.", +"Bidding strategy is not supported in experiments.", +"Traffic split is not supported for some channel types." +], +"type": "string" +}, +"experimentError": { +"description": "The reasons for the experiment error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CANNOT_SET_START_DATE_IN_PAST", +"END_DATE_BEFORE_START_DATE", +"START_DATE_TOO_FAR_IN_FUTURE", +"DUPLICATE_EXPERIMENT_NAME", +"CANNOT_MODIFY_REMOVED_EXPERIMENT", +"START_DATE_ALREADY_PASSED", +"CANNOT_SET_END_DATE_IN_PAST", +"CANNOT_SET_STATUS_TO_REMOVED", +"CANNOT_MODIFY_PAST_END_DATE", +"INVALID_STATUS", +"INVALID_CAMPAIGN_CHANNEL_TYPE", +"OVERLAPPING_MEMBERS_AND_DATE_RANGE", +"INVALID_TRIAL_ARM_TRAFFIC_SPLIT", +"TRAFFIC_SPLIT_OVERLAPPING", +"SUM_TRIAL_ARM_TRAFFIC_UNEQUALS_TO_TRIAL_TRAFFIC_SPLIT_DENOMINATOR", +"CANNOT_MODIFY_TRAFFIC_SPLIT_AFTER_START", +"EXPERIMENT_NOT_FOUND", +"EXPERIMENT_NOT_YET_STARTED", +"CANNOT_HAVE_MULTIPLE_CONTROL_ARMS", +"IN_DESIGN_CAMPAIGNS_NOT_SET", +"CANNOT_SET_STATUS_TO_GRADUATED", +"CANNOT_CREATE_EXPERIMENT_CAMPAIGN_WITH_SHARED_BUDGET", +"CANNOT_CREATE_EXPERIMENT_CAMPAIGN_WITH_CUSTOM_BUDGET", +"STATUS_TRANSITION_INVALID", +"DUPLICATE_EXPERIMENT_CAMPAIGN_NAME", +"CANNOT_REMOVE_IN_CREATION_EXPERIMENT", +"CANNOT_ADD_CAMPAIGN_WITH_DEPRECATED_AD_TYPES", +"CANNOT_ENABLE_SYNC_FOR_UNSUPPORTED_EXPERIMENT_TYPE", +"INVALID_DURATION_FOR_AN_EXPERIMENT", +"MISSING_EU_POLITICAL_ADVERTISING_SELF_DECLARATION" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The start date of an experiment cannot be set in the past. Use a start date in the future.", +"The end date of an experiment is before its start date. Use an end date after the start date.", +"The start date of an experiment is too far in the future. Use a start date no more than 1 year in the future.", +"The experiment has the same name as an existing active experiment.", +"Experiments can only be modified when they are ENABLED.", +"The start date of an experiment cannot be modified if the existing start date has already passed.", +"The end date of an experiment cannot be set in the past.", +"The status of an experiment cannot be set to REMOVED.", +"The end date of an expired experiment cannot be modified.", +"The status is invalid.", +"Experiment arm contains campaigns with invalid advertising channel type.", +"A pair of trials share members and have overlapping date ranges.", +"Experiment arm contains invalid traffic split.", +"Experiment contains trial arms with overlapping traffic split.", +"The total traffic split of trial arms is not equal to 100.", +"Traffic split related settings (like traffic share bounds) can't be modified after the experiment has started.", +"The experiment could not be found.", +"Experiment has not begun.", +"The experiment cannot have more than one control arm.", +"The experiment doesn't set in-design campaigns.", +"Clients must use the graduate action to graduate experiments and cannot set the status to GRADUATED directly.", +"Cannot use shared budget on base campaign when scheduling an experiment.", +"Cannot use custom budget on base campaign when scheduling an experiment.", +"Invalid status transition.", +"The experiment campaign name conflicts with a pre-existing campaign.", +"Cannot remove in creation experiments.", +"Cannot add campaign with deprecated ad types. Deprecated ad types: ENHANCED_DISPLAY, GALLERY, GMAIL, KEYWORDLESS, TEXT.", +"Sync can only be enabled for supported experiment types. Supported experiment types: SEARCH_CUSTOM, DISPLAY_CUSTOM, DISPLAY_AUTOMATED_BIDDING_STRATEGY, SEARCH_AUTOMATED_BIDDING_STRATEGY.", +"Experiment length cannot be longer than max length.", +"The experiment's campaigns must self-declare whether they contain political advertising that targets the European Union." +], +"type": "string" +}, +"extensionFeedItemError": { +"description": "The reasons for the extension feed item error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"VALUE_OUT_OF_RANGE", +"URL_LIST_TOO_LONG", +"CANNOT_HAVE_RESTRICTION_ON_EMPTY_GEO_TARGETING", +"CANNOT_SET_WITH_FINAL_URLS", +"CANNOT_SET_WITHOUT_FINAL_URLS", +"INVALID_PHONE_NUMBER", +"PHONE_NUMBER_NOT_SUPPORTED_FOR_COUNTRY", +"CARRIER_SPECIFIC_SHORT_NUMBER_NOT_ALLOWED", +"PREMIUM_RATE_NUMBER_NOT_ALLOWED", +"DISALLOWED_NUMBER_TYPE", +"INVALID_DOMESTIC_PHONE_NUMBER_FORMAT", +"VANITY_PHONE_NUMBER_NOT_ALLOWED", +"INVALID_CALL_CONVERSION_ACTION", +"CUSTOMER_NOT_ON_ALLOWLIST_FOR_CALLTRACKING", +"CALLTRACKING_NOT_SUPPORTED_FOR_COUNTRY", +"CUSTOMER_CONSENT_FOR_CALL_RECORDING_REQUIRED", +"INVALID_APP_ID", +"QUOTES_IN_REVIEW_EXTENSION_SNIPPET", +"HYPHENS_IN_REVIEW_EXTENSION_SNIPPET", +"REVIEW_EXTENSION_SOURCE_INELIGIBLE", +"SOURCE_NAME_IN_REVIEW_EXTENSION_TEXT", +"INCONSISTENT_CURRENCY_CODES", +"PRICE_EXTENSION_HAS_DUPLICATED_HEADERS", +"PRICE_ITEM_HAS_DUPLICATED_HEADER_AND_DESCRIPTION", +"PRICE_EXTENSION_HAS_TOO_FEW_ITEMS", +"PRICE_EXTENSION_HAS_TOO_MANY_ITEMS", +"UNSUPPORTED_VALUE", +"UNSUPPORTED_VALUE_IN_SELECTED_LANGUAGE", +"INVALID_DEVICE_PREFERENCE", +"INVALID_SCHEDULE_END", +"DATE_TIME_MUST_BE_IN_ACCOUNT_TIME_ZONE", +"INVALID_SNIPPETS_HEADER", +"CANNOT_OPERATE_ON_REMOVED_FEED_ITEM", +"PHONE_NUMBER_NOT_SUPPORTED_WITH_CALLTRACKING_FOR_COUNTRY", +"CONFLICTING_CALL_CONVERSION_SETTINGS", +"EXTENSION_TYPE_MISMATCH", +"EXTENSION_SUBTYPE_REQUIRED", +"EXTENSION_TYPE_UNSUPPORTED", +"CANNOT_OPERATE_ON_FEED_WITH_MULTIPLE_MAPPINGS", +"CANNOT_OPERATE_ON_FEED_WITH_KEY_ATTRIBUTES", +"INVALID_PRICE_FORMAT", +"PROMOTION_INVALID_TIME", +"TOO_MANY_DECIMAL_PLACES_SPECIFIED", +"CONCRETE_EXTENSION_TYPE_REQUIRED", +"SCHEDULE_END_NOT_AFTER_START" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Value is not within the accepted range.", +"Url list is too long.", +"Cannot have a geo targeting restriction without having geo targeting.", +"Cannot simultaneously set sitelink field with final urls.", +"Must set field with final urls.", +"Phone number for a call extension is invalid.", +"Phone number for a call extension is not supported for the given country code.", +"A carrier specific number in short format is not allowed for call extensions.", +"Premium rate numbers are not allowed for call extensions.", +"Phone number type for a call extension is not allowed. For example, personal number is not allowed for a call extension in most regions.", +"Phone number for a call extension does not meet domestic format requirements.", +"Vanity phone numbers (for example, those including letters) are not allowed for call extensions.", +"Call conversion action provided for a call extension is invalid.", +"For a call extension, the customer is not on the allow-list for call tracking.", +"Call tracking is not supported for the given country for a call extension.", +"Customer hasn't consented for call recording, which is required for creating/updating call feed items. See https://support.google.com/google-ads/answer/7412639.", +"App id provided for an app extension is invalid.", +"Quotation marks present in the review text for a review extension.", +"Hyphen character present in the review text for a review extension.", +"A denylisted review source name or url was provided for a review extension.", +"Review source name should not be found in the review text.", +"Inconsistent currency codes.", +"Price extension cannot have duplicated headers.", +"Price item cannot have duplicated header and description.", +"Price extension has too few items.", +"Price extension has too many items.", +"The input value is not currently supported.", +"The input value is not currently supported in the selected language of an extension.", +"Unknown or unsupported device preference.", +"Invalid feed item schedule end time (for example, endHour = 24 and endMinute != 0).", +"Date time zone does not match the account's time zone.", +"Invalid structured snippet header.", +"Cannot operate on removed feed item.", +"Phone number not supported when call tracking enabled for country.", +"Cannot set call_conversion_action while call_conversion_tracking_enabled is set to true.", +"The type of the input extension feed item doesn't match the existing extension feed item.", +"The oneof field extension for example, subtype of extension feed item is required.", +"The referenced feed item is not mapped to a supported extension type.", +"Cannot operate on a Feed with more than one active FeedMapping.", +"Cannot operate on a Feed that has key attributes.", +"Input price is not in a valid format.", +"The promotion time is invalid.", +"This field has too many decimal places specified.", +"Concrete sub type of ExtensionFeedItem is required for this operation.", +"Feed item schedule end time must be after start time." +], +"type": "string" +}, +"extensionSettingError": { +"description": "The reasons for the extension setting error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"EXTENSIONS_REQUIRED", +"FEED_TYPE_EXTENSION_TYPE_MISMATCH", +"INVALID_FEED_TYPE", +"INVALID_FEED_TYPE_FOR_CUSTOMER_EXTENSION_SETTING", +"CANNOT_CHANGE_FEED_ITEM_ON_CREATE", +"CANNOT_UPDATE_NEWLY_CREATED_EXTENSION", +"NO_EXISTING_AD_GROUP_EXTENSION_SETTING_FOR_TYPE", +"NO_EXISTING_CAMPAIGN_EXTENSION_SETTING_FOR_TYPE", +"NO_EXISTING_CUSTOMER_EXTENSION_SETTING_FOR_TYPE", +"AD_GROUP_EXTENSION_SETTING_ALREADY_EXISTS", +"CAMPAIGN_EXTENSION_SETTING_ALREADY_EXISTS", +"CUSTOMER_EXTENSION_SETTING_ALREADY_EXISTS", +"AD_GROUP_FEED_ALREADY_EXISTS_FOR_PLACEHOLDER_TYPE", +"CAMPAIGN_FEED_ALREADY_EXISTS_FOR_PLACEHOLDER_TYPE", +"CUSTOMER_FEED_ALREADY_EXISTS_FOR_PLACEHOLDER_TYPE", +"VALUE_OUT_OF_RANGE", +"CANNOT_SET_FIELD_WITH_FINAL_URLS", +"FINAL_URLS_NOT_SET", +"INVALID_PHONE_NUMBER", +"PHONE_NUMBER_NOT_SUPPORTED_FOR_COUNTRY", +"CARRIER_SPECIFIC_SHORT_NUMBER_NOT_ALLOWED", +"PREMIUM_RATE_NUMBER_NOT_ALLOWED", +"DISALLOWED_NUMBER_TYPE", +"INVALID_DOMESTIC_PHONE_NUMBER_FORMAT", +"VANITY_PHONE_NUMBER_NOT_ALLOWED", +"INVALID_COUNTRY_CODE", +"INVALID_CALL_CONVERSION_TYPE_ID", +"CUSTOMER_NOT_IN_ALLOWLIST_FOR_CALLTRACKING", +"CALLTRACKING_NOT_SUPPORTED_FOR_COUNTRY", +"INVALID_APP_ID", +"QUOTES_IN_REVIEW_EXTENSION_SNIPPET", +"HYPHENS_IN_REVIEW_EXTENSION_SNIPPET", +"REVIEW_EXTENSION_SOURCE_NOT_ELIGIBLE", +"SOURCE_NAME_IN_REVIEW_EXTENSION_TEXT", +"MISSING_FIELD", +"INCONSISTENT_CURRENCY_CODES", +"PRICE_EXTENSION_HAS_DUPLICATED_HEADERS", +"PRICE_ITEM_HAS_DUPLICATED_HEADER_AND_DESCRIPTION", +"PRICE_EXTENSION_HAS_TOO_FEW_ITEMS", +"PRICE_EXTENSION_HAS_TOO_MANY_ITEMS", +"UNSUPPORTED_VALUE", +"INVALID_DEVICE_PREFERENCE", +"INVALID_SCHEDULE_END", +"DATE_TIME_MUST_BE_IN_ACCOUNT_TIME_ZONE", +"OVERLAPPING_SCHEDULES_NOT_ALLOWED", +"SCHEDULE_END_NOT_AFTER_START", +"TOO_MANY_SCHEDULES_PER_DAY", +"DUPLICATE_EXTENSION_FEED_ITEM_EDIT", +"INVALID_SNIPPETS_HEADER", +"PHONE_NUMBER_NOT_SUPPORTED_WITH_CALLTRACKING_FOR_COUNTRY", +"CAMPAIGN_TARGETING_MISMATCH", +"CANNOT_OPERATE_ON_REMOVED_FEED", +"EXTENSION_TYPE_REQUIRED", +"INCOMPATIBLE_UNDERLYING_MATCHING_FUNCTION", +"START_DATE_AFTER_END_DATE", +"INVALID_PRICE_FORMAT", +"PROMOTION_INVALID_TIME", +"PROMOTION_CANNOT_SET_PERCENT_DISCOUNT_AND_MONEY_DISCOUNT", +"PROMOTION_CANNOT_SET_PROMOTION_CODE_AND_ORDERS_OVER_AMOUNT", +"TOO_MANY_DECIMAL_PLACES_SPECIFIED", +"INVALID_LANGUAGE_CODE", +"UNSUPPORTED_LANGUAGE", +"CUSTOMER_CONSENT_FOR_CALL_RECORDING_REQUIRED", +"EXTENSION_SETTING_UPDATE_IS_A_NOOP", +"DISALLOWED_TEXT" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"A platform restriction was provided without input extensions or existing extensions.", +"The provided feed type does not correspond to the provided extensions.", +"The provided feed type cannot be used.", +"The provided feed type cannot be used at the customer level.", +"Cannot change a feed item field on a CREATE operation.", +"Cannot update an extension that is not already in this setting.", +"There is no existing AdGroupExtensionSetting for this type.", +"There is no existing CampaignExtensionSetting for this type.", +"There is no existing CustomerExtensionSetting for this type.", +"The AdGroupExtensionSetting already exists. UPDATE should be used to modify the existing AdGroupExtensionSetting.", +"The CampaignExtensionSetting already exists. UPDATE should be used to modify the existing CampaignExtensionSetting.", +"The CustomerExtensionSetting already exists. UPDATE should be used to modify the existing CustomerExtensionSetting.", +"An active ad group feed already exists for this place holder type.", +"An active campaign feed already exists for this place holder type.", +"An active customer feed already exists for this place holder type.", +"Value is not within the accepted range.", +"Cannot simultaneously set specified field with final urls.", +"Must set field with final urls.", +"Phone number for a call extension is invalid.", +"Phone number for a call extension is not supported for the given country code.", +"A carrier specific number in short format is not allowed for call extensions.", +"Premium rate numbers are not allowed for call extensions.", +"Phone number type for a call extension is not allowed.", +"Phone number for a call extension does not meet domestic format requirements.", +"Vanity phone numbers (for example, those including letters) are not allowed for call extensions.", +"Country code provided for a call extension is invalid.", +"Call conversion type id provided for a call extension is invalid.", +"For a call extension, the customer is not on the allow-list for call tracking.", +"Call tracking is not supported for the given country for a call extension.", +"App id provided for an app extension is invalid.", +"Quotation marks present in the review text for a review extension.", +"Hyphen character present in the review text for a review extension.", +"A blocked review source name or url was provided for a review extension.", +"Review source name should not be found in the review text.", +"Field must be set.", +"Inconsistent currency codes.", +"Price extension cannot have duplicated headers.", +"Price item cannot have duplicated header and description.", +"Price extension has too few items", +"Price extension has too many items", +"The input value is not currently supported.", +"Unknown or unsupported device preference.", +"Invalid feed item schedule end time (for example, endHour = 24 and endMinute != 0).", +"Date time zone does not match the account's time zone.", +"Overlapping feed item schedule times (for example, 7-10AM and 8-11AM) are not allowed.", +"Feed item schedule end time must be after start time.", +"There are too many feed item schedules per day.", +"Cannot edit the same extension feed item more than once in the same request.", +"Invalid structured snippet header.", +"Phone number with call tracking enabled is not supported for the specified country.", +"The targeted adgroup must belong to the targeted campaign.", +"The feed used by the ExtensionSetting is removed and cannot be operated on. Remove the ExtensionSetting to allow a new one to be created using an active feed.", +"The ExtensionFeedItem type is required for this operation.", +"The matching function that links the extension feed to the customer, campaign, or ad group is not compatible with the ExtensionSetting services.", +"Start date must be before end date.", +"Input price is not in a valid format.", +"The promotion time is invalid.", +"Cannot set both percent discount and money discount fields.", +"Cannot set both promotion code and orders over amount fields.", +"This field has too many decimal places specified.", +"The language code is not valid.", +"The language is not supported.", +"Customer hasn't consented for call recording, which is required for adding/updating call extensions. See https://support.google.com/google-ads/answer/7412639.", +"The UPDATE operation does not specify any fields other than the resource name in the update mask.", +"The extension contains text which has been prohibited on policy grounds." +], +"type": "string" +}, +"feedAttributeReferenceError": { +"description": "The reasons for the feed attribute reference error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CANNOT_REFERENCE_REMOVED_FEED", +"INVALID_FEED_NAME", +"INVALID_FEED_ATTRIBUTE_NAME" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"A feed referenced by ID has been removed.", +"There is no enabled feed with the given name.", +"There is no feed attribute in an enabled feed with the given name." +], +"type": "string" +}, +"feedError": { +"description": "The reasons for the feed error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"ATTRIBUTE_NAMES_NOT_UNIQUE", +"ATTRIBUTES_DO_NOT_MATCH_EXISTING_ATTRIBUTES", +"CANNOT_SPECIFY_USER_ORIGIN_FOR_SYSTEM_FEED", +"CANNOT_SPECIFY_GOOGLE_ORIGIN_FOR_NON_SYSTEM_FEED", +"CANNOT_SPECIFY_FEED_ATTRIBUTES_FOR_SYSTEM_FEED", +"CANNOT_UPDATE_FEED_ATTRIBUTES_WITH_ORIGIN_GOOGLE", +"FEED_REMOVED", +"INVALID_ORIGIN_VALUE", +"FEED_ORIGIN_IS_NOT_USER", +"INVALID_AUTH_TOKEN_FOR_EMAIL", +"INVALID_EMAIL", +"DUPLICATE_FEED_NAME", +"INVALID_FEED_NAME", +"MISSING_OAUTH_INFO", +"NEW_ATTRIBUTE_CANNOT_BE_PART_OF_UNIQUE_KEY", +"TOO_MANY_ATTRIBUTES", +"INVALID_BUSINESS_ACCOUNT", +"BUSINESS_ACCOUNT_CANNOT_ACCESS_LOCATION_ACCOUNT", +"INVALID_AFFILIATE_CHAIN_ID", +"DUPLICATE_SYSTEM_FEED", +"GMB_ACCESS_ERROR", +"CANNOT_HAVE_LOCATION_AND_AFFILIATE_LOCATION_FEEDS", +"LEGACY_EXTENSION_TYPE_READ_ONLY" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The names of the FeedAttributes must be unique.", +"The attribute list must be an exact copy of the existing list if the attribute ID's are present.", +"Cannot specify USER origin for a system generated feed.", +"Cannot specify GOOGLE origin for a non-system generated feed.", +"Cannot specify feed attributes for system feed.", +"Cannot update FeedAttributes on feed with origin GOOGLE.", +"The given ID refers to a removed Feed. Removed Feeds are immutable.", +"The origin of the feed is not valid for the client.", +"A user can only create and modify feeds with USER origin.", +"Invalid auth token for the given email.", +"Invalid email specified.", +"Feed name matches that of another active Feed.", +"Name of feed is not allowed.", +"Missing OAuthInfo.", +"New FeedAttributes must not affect the unique key.", +"Too many FeedAttributes for a Feed.", +"The business account is not valid.", +"Business account cannot access Business Profile.", +"Invalid chain ID provided for affiliate location feed.", +"There is already a feed with the given system feed generation data.", +"An error occurred accessing Business Profile.", +"A customer cannot have both LOCATION and AFFILIATE_LOCATION feeds.", +"Feed-based extension is read-only for this extension type." +], +"type": "string" +}, +"feedItemError": { +"description": "The reasons for the feed item error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CANNOT_CONVERT_ATTRIBUTE_VALUE_FROM_STRING", +"CANNOT_OPERATE_ON_REMOVED_FEED_ITEM", +"DATE_TIME_MUST_BE_IN_ACCOUNT_TIME_ZONE", +"KEY_ATTRIBUTES_NOT_FOUND", +"INVALID_URL", +"MISSING_KEY_ATTRIBUTES", +"KEY_ATTRIBUTES_NOT_UNIQUE", +"CANNOT_MODIFY_KEY_ATTRIBUTE_VALUE", +"SIZE_TOO_LARGE_FOR_MULTI_VALUE_ATTRIBUTE", +"LEGACY_FEED_TYPE_READ_ONLY" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Cannot convert the feed attribute value from string to its real type.", +"Cannot operate on removed feed item.", +"Date time zone does not match the account's time zone.", +"Feed item with the key attributes could not be found.", +"Url feed attribute value is not valid.", +"Some key attributes are missing.", +"Feed item has same key attributes as another feed item.", +"Cannot modify key attributes on an existing feed item.", +"The feed attribute value is too large.", +"Feed is read only." +], +"type": "string" +}, +"feedItemSetError": { +"description": "The reasons for the feed item set error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"FEED_ITEM_SET_REMOVED", +"CANNOT_CLEAR_DYNAMIC_FILTER", +"CANNOT_CREATE_DYNAMIC_FILTER", +"INVALID_FEED_TYPE", +"DUPLICATE_NAME", +"WRONG_DYNAMIC_FILTER_FOR_FEED_TYPE", +"DYNAMIC_FILTER_INVALID_CHAIN_IDS" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The given ID refers to a removed FeedItemSet.", +"The dynamic filter of a feed item set cannot be cleared on UPDATE if it exists. A set is either static or dynamic once added, and that cannot change.", +"The dynamic filter of a feed item set cannot be created on UPDATE if it does not exist. A set is either static or dynamic once added, and that cannot change.", +"FeedItemSets can only be made for location or affiliate location feeds.", +"FeedItemSets duplicate name. Name should be unique within an account.", +"The feed type of the parent Feed is not compatible with the type of dynamic filter being set. For example, you can only set dynamic_location_set_filter for LOCATION feed item sets.", +"Chain ID specified for AffiliateLocationFeedData is invalid." +], +"type": "string" +}, +"feedItemSetLinkError": { +"description": "The reasons for the feed item set link error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"FEED_ID_MISMATCH", +"NO_MUTATE_ALLOWED_FOR_DYNAMIC_SET" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The feed IDs of the FeedItemSet and FeedItem do not match. Only FeedItems in a given Feed can be linked to a FeedItemSet in that Feed.", +"Cannot add or remove links to a dynamic set." +], +"type": "string" +}, +"feedItemTargetError": { +"description": "The reasons for the feed item target error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"MUST_SET_TARGET_ONEOF_ON_CREATE", +"FEED_ITEM_TARGET_ALREADY_EXISTS", +"FEED_ITEM_SCHEDULES_CANNOT_OVERLAP", +"TARGET_LIMIT_EXCEEDED_FOR_GIVEN_TYPE", +"TOO_MANY_SCHEDULES_PER_DAY", +"CANNOT_HAVE_ENABLED_CAMPAIGN_AND_ENABLED_AD_GROUP_TARGETS", +"DUPLICATE_AD_SCHEDULE", +"DUPLICATE_KEYWORD" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"On CREATE, the FeedItemTarget must have a populated field in the oneof target.", +"The specified feed item target already exists, so it cannot be added.", +"The schedules for a given feed item cannot overlap.", +"Too many targets of a given type were added for a single feed item.", +"Too many AdSchedules are enabled for the feed item for the given day.", +"A feed item may either have an enabled campaign target or an enabled ad group target.", +"Duplicate ad schedules aren't allowed.", +"Duplicate keywords aren't allowed." +], +"type": "string" +}, +"feedItemValidationError": { +"description": "The reasons for the feed item validation error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"STRING_TOO_SHORT", +"STRING_TOO_LONG", +"VALUE_NOT_SPECIFIED", +"INVALID_DOMESTIC_PHONE_NUMBER_FORMAT", +"INVALID_PHONE_NUMBER", +"PHONE_NUMBER_NOT_SUPPORTED_FOR_COUNTRY", +"PREMIUM_RATE_NUMBER_NOT_ALLOWED", +"DISALLOWED_NUMBER_TYPE", +"VALUE_OUT_OF_RANGE", +"CALLTRACKING_NOT_SUPPORTED_FOR_COUNTRY", +"CUSTOMER_NOT_IN_ALLOWLIST_FOR_CALLTRACKING", +"INVALID_COUNTRY_CODE", +"INVALID_APP_ID", +"MISSING_ATTRIBUTES_FOR_FIELDS", +"INVALID_TYPE_ID", +"INVALID_EMAIL_ADDRESS", +"INVALID_HTTPS_URL", +"MISSING_DELIVERY_ADDRESS", +"START_DATE_AFTER_END_DATE", +"MISSING_FEED_ITEM_START_TIME", +"MISSING_FEED_ITEM_END_TIME", +"MISSING_FEED_ITEM_ID", +"VANITY_PHONE_NUMBER_NOT_ALLOWED", +"INVALID_REVIEW_EXTENSION_SNIPPET", +"INVALID_NUMBER_FORMAT", +"INVALID_DATE_FORMAT", +"INVALID_PRICE_FORMAT", +"UNKNOWN_PLACEHOLDER_FIELD", +"MISSING_ENHANCED_SITELINK_DESCRIPTION_LINE", +"REVIEW_EXTENSION_SOURCE_INELIGIBLE", +"HYPHENS_IN_REVIEW_EXTENSION_SNIPPET", +"DOUBLE_QUOTES_IN_REVIEW_EXTENSION_SNIPPET", +"QUOTES_IN_REVIEW_EXTENSION_SNIPPET", +"INVALID_FORM_ENCODED_PARAMS", +"INVALID_URL_PARAMETER_NAME", +"NO_GEOCODING_RESULT", +"SOURCE_NAME_IN_REVIEW_EXTENSION_TEXT", +"CARRIER_SPECIFIC_SHORT_NUMBER_NOT_ALLOWED", +"INVALID_PLACEHOLDER_FIELD_ID", +"INVALID_URL_TAG", +"LIST_TOO_LONG", +"INVALID_ATTRIBUTES_COMBINATION", +"DUPLICATE_VALUES", +"INVALID_CALL_CONVERSION_ACTION_ID", +"CANNOT_SET_WITHOUT_FINAL_URLS", +"APP_ID_DOESNT_EXIST_IN_APP_STORE", +"INVALID_FINAL_URL", +"INVALID_TRACKING_URL", +"INVALID_FINAL_URL_FOR_APP_DOWNLOAD_URL", +"LIST_TOO_SHORT", +"INVALID_USER_ACTION", +"INVALID_TYPE_NAME", +"INVALID_EVENT_CHANGE_STATUS", +"INVALID_SNIPPETS_HEADER", +"INVALID_ANDROID_APP_LINK", +"NUMBER_TYPE_WITH_CALLTRACKING_NOT_SUPPORTED_FOR_COUNTRY", +"RESERVED_KEYWORD_OTHER", +"DUPLICATE_OPTION_LABELS", +"DUPLICATE_OPTION_PREFILLS", +"UNEQUAL_LIST_LENGTHS", +"INCONSISTENT_CURRENCY_CODES", +"PRICE_EXTENSION_HAS_DUPLICATED_HEADERS", +"ITEM_HAS_DUPLICATED_HEADER_AND_DESCRIPTION", +"PRICE_EXTENSION_HAS_TOO_FEW_ITEMS", +"UNSUPPORTED_VALUE", +"INVALID_FINAL_MOBILE_URL", +"INVALID_KEYWORDLESS_AD_RULE_LABEL", +"VALUE_TRACK_PARAMETER_NOT_SUPPORTED", +"UNSUPPORTED_VALUE_IN_SELECTED_LANGUAGE", +"INVALID_IOS_APP_LINK", +"MISSING_IOS_APP_LINK_OR_IOS_APP_STORE_ID", +"PROMOTION_INVALID_TIME", +"PROMOTION_CANNOT_SET_PERCENT_OFF_AND_MONEY_AMOUNT_OFF", +"PROMOTION_CANNOT_SET_PROMOTION_CODE_AND_ORDERS_OVER_AMOUNT", +"TOO_MANY_DECIMAL_PLACES_SPECIFIED", +"AD_CUSTOMIZERS_NOT_ALLOWED", +"INVALID_LANGUAGE_CODE", +"UNSUPPORTED_LANGUAGE", +"IF_FUNCTION_NOT_ALLOWED", +"INVALID_FINAL_URL_SUFFIX", +"INVALID_TAG_IN_FINAL_URL_SUFFIX", +"INVALID_FINAL_URL_SUFFIX_FORMAT", +"CUSTOMER_CONSENT_FOR_CALL_RECORDING_REQUIRED", +"ONLY_ONE_DELIVERY_OPTION_IS_ALLOWED", +"NO_DELIVERY_OPTION_IS_SET", +"INVALID_CONVERSION_REPORTING_STATE", +"IMAGE_SIZE_WRONG", +"EMAIL_DELIVERY_NOT_AVAILABLE_IN_COUNTRY", +"AUTO_REPLY_NOT_AVAILABLE_IN_COUNTRY", +"INVALID_LATITUDE_VALUE", +"INVALID_LONGITUDE_VALUE", +"TOO_MANY_LABELS", +"INVALID_IMAGE_URL", +"MISSING_LATITUDE_VALUE", +"MISSING_LONGITUDE_VALUE", +"ADDRESS_NOT_FOUND", +"ADDRESS_NOT_TARGETABLE", +"INVALID_ASSET_ID", +"INCOMPATIBLE_ASSET_TYPE", +"IMAGE_ERROR_UNEXPECTED_SIZE", +"IMAGE_ERROR_ASPECT_RATIO_NOT_ALLOWED", +"IMAGE_ERROR_FILE_TOO_LARGE", +"IMAGE_ERROR_FORMAT_NOT_ALLOWED", +"IMAGE_ERROR_CONSTRAINTS_VIOLATED", +"IMAGE_ERROR_SERVER_ERROR" +], +"enumDescriptions": [ +"No value has been specified.", +"Used for return value only. Represents value unknown in this version.", +"String is too short.", +"String is too long.", +"Value is not provided.", +"Phone number format is invalid for region.", +"String does not represent a phone number.", +"Phone number format is not compatible with country code.", +"Premium rate number is not allowed.", +"Phone number type is not allowed.", +"Specified value is outside of the valid range.", +"Call tracking is not supported in the selected country.", +"Customer is not on the allow-list for call tracking.", +"Country code is invalid.", +"The specified mobile app id is invalid.", +"Some required field attributes are missing.", +"Invalid email button type for email extension.", +"Email address is invalid.", +"The HTTPS URL in email extension is invalid.", +"Delivery address is missing from email extension.", +"FeedItem scheduling start date comes after end date.", +"FeedItem scheduling start time is missing.", +"FeedItem scheduling end time is missing.", +"Cannot compute system attributes on a FeedItem that has no FeedItemId.", +"Call extension vanity phone numbers are not supported.", +"Invalid review text.", +"Invalid format for numeric value in ad parameter.", +"Invalid format for date value in ad parameter.", +"Invalid format for price value in ad parameter.", +"Unrecognized type given for value in ad parameter.", +"Enhanced sitelinks must have both description lines specified.", +"Review source is ineligible.", +"Review text cannot contain hyphens or dashes.", +"Review text cannot contain double quote characters.", +"Review text cannot contain quote characters.", +"Parameters are encoded in the wrong format.", +"URL parameter name must contain only letters, numbers, underscores, and dashes.", +"Cannot find address location.", +"Review extension text has source name.", +"Some phone numbers can be shorter than usual. Some of these short numbers are carrier-specific, and we disallow those in ad extensions because they will not be available to all users.", +"Triggered when a request references a placeholder field id that does not exist.", +"URL contains invalid ValueTrack tags or format.", +"Provided list exceeds acceptable size.", +"Certain combinations of attributes aren't allowed to be specified in the same feed item.", +"An attribute has the same value repeatedly.", +"Advertisers can link a conversion action with a phone number to indicate that sufficiently long calls forwarded to that phone number should be counted as conversions of the specified type. This is an error message indicating that the conversion action specified is invalid (for example, the conversion action does not exist within the appropriate Google Ads account, or it is a type of conversion not appropriate to phone call conversions).", +"Tracking template requires final url to be set.", +"An app id was provided that doesn't exist in the given app store.", +"Invalid U2 final url.", +"Invalid U2 tracking url.", +"Final URL should start from App download URL.", +"List provided is too short.", +"User Action field has invalid value.", +"Type field has invalid value.", +"Change status for event is invalid.", +"The header of a structured snippets extension is not one of the valid headers.", +"Android app link is not formatted correctly", +"Phone number incompatible with call tracking for country.", +"The input is identical to a reserved keyword", +"Each option label in the message extension must be unique.", +"Each option prefill in the message extension must be unique.", +"In message extensions, the number of optional labels and optional prefills must be the same.", +"All currency codes in an ad extension must be the same.", +"Headers in price extension are not unique.", +"Header and description in an item are the same.", +"Price extension has too few items.", +"The given value is not supported.", +"Invalid final mobile url.", +"The given string value of Label contains invalid characters", +"The given URL contains value track parameters.", +"The given value is not supported in the selected language of an extension.", +"The iOS app link is not formatted correctly.", +"iOS app link or iOS app store id is missing.", +"Promotion time is invalid.", +"Both the percent off and money amount off fields are set.", +"Both the promotion code and orders over amount fields are set.", +"Too many decimal places are specified.", +"Ad Customizers are present and not allowed.", +"Language code is not valid.", +"Language is not supported.", +"IF Function is present and not allowed.", +"Final url suffix is not valid.", +"Final url suffix contains an invalid tag.", +"Final url suffix is formatted incorrectly.", +"Consent for call recording, which is required for the use of call extensions, was not provided by the advertiser. See https://support.google.com/google-ads/answer/7412639.", +"Multiple message delivery options are set.", +"No message delivery option is set.", +"String value of conversion reporting state field is not valid.", +"Image size is not right.", +"Email delivery is not supported in the country specified in the country code field.", +"Auto reply is not supported in the country specified in the country code field.", +"Invalid value specified for latitude.", +"Invalid value specified for longitude.", +"Too many label fields provided.", +"Invalid image url.", +"Latitude value is missing.", +"Longitude value is missing.", +"Unable to find address.", +"Cannot target provided address.", +"The specified asset ID does not exist.", +"The asset type cannot be set for the field.", +"The image has unexpected size.", +"The image aspect ratio is not allowed.", +"The image file is too large.", +"The image format is unsupported.", +"Image violates constraints without more details.", +"An error occurred when validating image." +], +"type": "string" +}, +"feedMappingError": { +"description": "The reasons for the feed mapping error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_PLACEHOLDER_FIELD", +"INVALID_CRITERION_FIELD", +"INVALID_PLACEHOLDER_TYPE", +"INVALID_CRITERION_TYPE", +"NO_ATTRIBUTE_FIELD_MAPPINGS", +"FEED_ATTRIBUTE_TYPE_MISMATCH", +"CANNOT_OPERATE_ON_MAPPINGS_FOR_SYSTEM_GENERATED_FEED", +"MULTIPLE_MAPPINGS_FOR_PLACEHOLDER_TYPE", +"MULTIPLE_MAPPINGS_FOR_CRITERION_TYPE", +"MULTIPLE_MAPPINGS_FOR_PLACEHOLDER_FIELD", +"MULTIPLE_MAPPINGS_FOR_CRITERION_FIELD", +"UNEXPECTED_ATTRIBUTE_FIELD_MAPPINGS", +"LOCATION_PLACEHOLDER_ONLY_FOR_PLACES_FEEDS", +"CANNOT_MODIFY_MAPPINGS_FOR_TYPED_FEED", +"INVALID_PLACEHOLDER_TYPE_FOR_NON_SYSTEM_GENERATED_FEED", +"INVALID_PLACEHOLDER_TYPE_FOR_SYSTEM_GENERATED_FEED_TYPE", +"ATTRIBUTE_FIELD_MAPPING_MISSING_FIELD", +"LEGACY_FEED_TYPE_READ_ONLY" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The given placeholder field does not exist.", +"The given criterion field does not exist.", +"The given placeholder type does not exist.", +"The given criterion type does not exist.", +"A feed mapping must contain at least one attribute field mapping.", +"The type of the feed attribute referenced in the attribute field mapping must match the type of the placeholder field.", +"A feed mapping for a system generated feed cannot be operated on.", +"Only one feed mapping for a placeholder type is allowed per feed or customer (depending on the placeholder type).", +"Only one feed mapping for a criterion type is allowed per customer.", +"Only one feed attribute mapping for a placeholder field is allowed (depending on the placeholder type).", +"Only one feed attribute mapping for a criterion field is allowed (depending on the criterion type).", +"This feed mapping may not contain any explicit attribute field mappings.", +"Location placeholder feed mappings can only be created for Places feeds.", +"Mappings for typed feeds cannot be modified.", +"The given placeholder type can only be mapped to system generated feeds.", +"The given placeholder type cannot be mapped to a system generated feed with the given type.", +"The \"field\" oneof was not set in an AttributeFieldMapping.", +"Feed is read only." +], +"type": "string" +}, +"fieldError": { +"description": "The reasons for the field error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"REQUIRED", +"IMMUTABLE_FIELD", +"INVALID_VALUE", +"VALUE_MUST_BE_UNSET", +"REQUIRED_NONEMPTY_LIST", +"FIELD_CANNOT_BE_CLEARED", +"BLOCKED_VALUE", +"FIELD_CAN_ONLY_BE_CLEARED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The required field was not present.", +"The field attempted to be mutated is immutable.", +"The field's value is invalid.", +"The field cannot be set.", +"The required repeated field was empty.", +"The field cannot be cleared.", +"The field's value is on a deny-list for this field.", +"The field's value cannot be modified, except for clearing." +], +"type": "string" +}, +"fieldMaskError": { +"description": "An error with a field mask", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"FIELD_MASK_MISSING", +"FIELD_MASK_NOT_ALLOWED", +"FIELD_NOT_FOUND", +"FIELD_HAS_SUBFIELDS" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The field mask must be provided for update operations.", +"The field mask must be empty for create and remove operations.", +"The field mask contained an invalid field.", +"The field mask updated a field with subfields. Fields with subfields may be cleared, but not updated. To fix this, the field mask should select all the subfields of the invalid field." +], +"type": "string" +}, +"finalUrlExpansionAssetViewError": { +"description": "The reasons for the final url expansion asset view error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"MISSING_REQUIRED_FILTER", +"REQUIRES_ADVERTISING_CHANNEL_TYPE_FILTER", +"INVALID_ADVERTISING_CHANNEL_TYPE_IN_FILTER", +"CANNOT_SELECT_ASSET_GROUP", +"CANNOT_SELECT_AD_GROUP", +"REQUIRES_FILTER_BY_SINGLE_RESOURCE", +"CANNOT_SELECT_BOTH_AD_GROUP_AND_ASSET_GROUP", +"CANNOT_FILTER_BY_BOTH_AD_GROUP_AND_ASSET_GROUP" +], +"enumDescriptions": [ +"Name unspecified.", +"The received error code is not known in this version.", +"At least one required filter has to be applied in the query.", +"Advertising channel type filter is required.", +"Advertising channel type filter has an invalid value.", +"Asset group cannot be selected in the query.", +"Ad group cannot be selected in the query.", +"A selected field/resource requires filtering by a single resource.", +"Both ad group and asset group cannot be selected in the query.", +"Both ad group and asset group cannot be filtered in the query." +], +"type": "string" +}, +"functionError": { +"description": "The reasons for the function error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_FUNCTION_FORMAT", +"DATA_TYPE_MISMATCH", +"INVALID_CONJUNCTION_OPERANDS", +"INVALID_NUMBER_OF_OPERANDS", +"INVALID_OPERAND_TYPE", +"INVALID_OPERATOR", +"INVALID_REQUEST_CONTEXT_TYPE", +"INVALID_FUNCTION_FOR_CALL_PLACEHOLDER", +"INVALID_FUNCTION_FOR_PLACEHOLDER", +"INVALID_OPERAND", +"MISSING_CONSTANT_OPERAND_VALUE", +"INVALID_CONSTANT_OPERAND_VALUE", +"INVALID_NESTING", +"MULTIPLE_FEED_IDS_NOT_SUPPORTED", +"INVALID_FUNCTION_FOR_FEED_WITH_FIXED_SCHEMA", +"INVALID_ATTRIBUTE_NAME" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The format of the function is not recognized as a supported function format.", +"Operand data types do not match.", +"The operands cannot be used together in a conjunction.", +"Invalid numer of Operands.", +"Operand Type not supported.", +"Operator not supported.", +"Request context type not supported.", +"The matching function is not allowed for call placeholders", +"The matching function is not allowed for the specified placeholder", +"Invalid operand.", +"Missing value for the constant operand.", +"The value of the constant operand is invalid.", +"Invalid function nesting.", +"The Feed ID was different from another Feed ID in the same function.", +"The matching function is invalid for use with a feed with a fixed schema.", +"Invalid attribute name." +], +"type": "string" +}, +"functionParsingError": { +"description": "The reasons for the function parsing error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"NO_MORE_INPUT", +"EXPECTED_CHARACTER", +"UNEXPECTED_SEPARATOR", +"UNMATCHED_LEFT_BRACKET", +"UNMATCHED_RIGHT_BRACKET", +"TOO_MANY_NESTED_FUNCTIONS", +"MISSING_RIGHT_HAND_OPERAND", +"INVALID_OPERATOR_NAME", +"FEED_ATTRIBUTE_OPERAND_ARGUMENT_NOT_INTEGER", +"NO_OPERANDS", +"TOO_MANY_OPERANDS" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Unexpected end of function string.", +"Could not find an expected character.", +"Unexpected separator character.", +"Unmatched left bracket or parenthesis.", +"Unmatched right bracket or parenthesis.", +"Functions are nested too deeply.", +"Missing right-hand-side operand.", +"Invalid operator/function name.", +"Feed attribute operand's argument is not an integer.", +"Missing function operands.", +"Function had too many operands." +], +"type": "string" +}, +"geoTargetConstantSuggestionError": { +"description": "The reasons for the geo target constant suggestion error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"LOCATION_NAME_SIZE_LIMIT", +"LOCATION_NAME_LIMIT", +"INVALID_COUNTRY_CODE", +"REQUEST_PARAMETERS_UNSET" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"A location name cannot be greater than 300 characters.", +"At most 25 location names can be specified in a SuggestGeoTargetConstants method.", +"The country code is invalid.", +"Geo target constant resource names or location names must be provided in the request." +], +"type": "string" +}, +"goalError": { +"description": "The reasons for the goal error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"RETENTION_GOAL_ALREADY_EXISTS", +"HIGH_LIFETIME_VALUE_PRESENT_BUT_VALUE_ABSENT", +"HIGH_LIFETIME_VALUE_LESS_THAN_OR_EQUAL_TO_VALUE", +"CUSTOMER_LIFECYCLE_OPTIMIZATION_ACCOUNT_TYPE_NOT_ALLOWED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Retention goal already exists.", +"When using customer lifecycle optimization goal, if high lifetime value is present then value should be present.", +"When using customer lifecycle optimization goal, high lifetime value should be greater than value.", +"Only Google Ads account can have customer lifecycle optimization goal." +], +"type": "string" +}, +"headerError": { +"description": "The reasons for the header error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_LOGIN_CUSTOMER_ID", +"INVALID_LINKED_CUSTOMER_ID" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The login customer ID could not be validated.", +"The linked customer ID could not be validated." +], +"type": "string" +}, +"idError": { +"description": "The reasons for the id error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"NOT_FOUND" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"ID not found" +], +"type": "string" +}, +"identityVerificationError": { +"description": "The reasons for an identity verification error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"NO_EFFECTIVE_BILLING", +"BILLING_NOT_ON_MONTHLY_INVOICING", +"VERIFICATION_ALREADY_STARTED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"No effective billing linked to this customer.", +"Customer is not on monthly invoicing.", +"Verification for this program type was already started." +], +"type": "string" +}, +"imageError": { +"description": "The reasons for the image error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_IMAGE", +"STORAGE_ERROR", +"BAD_REQUEST", +"UNEXPECTED_SIZE", +"ANIMATED_NOT_ALLOWED", +"ANIMATION_TOO_LONG", +"SERVER_ERROR", +"CMYK_JPEG_NOT_ALLOWED", +"FLASH_NOT_ALLOWED", +"FLASH_WITHOUT_CLICKTAG", +"FLASH_ERROR_AFTER_FIXING_CLICK_TAG", +"ANIMATED_VISUAL_EFFECT", +"FLASH_ERROR", +"LAYOUT_PROBLEM", +"PROBLEM_READING_IMAGE_FILE", +"ERROR_STORING_IMAGE", +"ASPECT_RATIO_NOT_ALLOWED", +"FLASH_HAS_NETWORK_OBJECTS", +"FLASH_HAS_NETWORK_METHODS", +"FLASH_HAS_URL", +"FLASH_HAS_MOUSE_TRACKING", +"FLASH_HAS_RANDOM_NUM", +"FLASH_SELF_TARGETS", +"FLASH_BAD_GETURL_TARGET", +"FLASH_VERSION_NOT_SUPPORTED", +"FLASH_WITHOUT_HARD_CODED_CLICK_URL", +"INVALID_FLASH_FILE", +"FAILED_TO_FIX_CLICK_TAG_IN_FLASH", +"FLASH_ACCESSES_NETWORK_RESOURCES", +"FLASH_EXTERNAL_JS_CALL", +"FLASH_EXTERNAL_FS_CALL", +"FILE_TOO_LARGE", +"IMAGE_DATA_TOO_LARGE", +"IMAGE_PROCESSING_ERROR", +"IMAGE_TOO_SMALL", +"INVALID_INPUT", +"PROBLEM_READING_FILE", +"IMAGE_CONSTRAINTS_VIOLATED", +"FORMAT_NOT_ALLOWED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The image is not valid.", +"The image could not be stored.", +"There was a problem with the request.", +"The image is not of legal dimensions.", +"Animated image are not permitted.", +"Animation is too long.", +"There was an error on the server.", +"Image cannot be in CMYK color format.", +"Flash images are not permitted.", +"Flash images must support clickTag.", +"A flash error has occurred after fixing the click tag.", +"Unacceptable visual effects.", +"There was a problem with the flash image.", +"Incorrect image layout.", +"There was a problem reading the image file.", +"There was an error storing the image.", +"The aspect ratio of the image is not allowed.", +"Flash cannot have network objects.", +"Flash cannot have network methods.", +"Flash cannot have a Url.", +"Flash cannot use mouse tracking.", +"Flash cannot have a random number.", +"Ad click target cannot be '_self'.", +"GetUrl method should only use '_blank'.", +"Flash version is not supported.", +"Flash movies need to have hard coded click URL or clickTAG", +"Uploaded flash file is corrupted.", +"Uploaded flash file can be parsed, but the click tag can not be fixed properly.", +"Flash movie accesses network resources", +"Flash movie attempts to call external javascript code", +"Flash movie attempts to call flash system commands", +"Image file is too large.", +"Image data is too large.", +"Error while processing the image.", +"Image is too small.", +"Input was invalid.", +"There was a problem reading the image file.", +"Image constraints are violated, but details like ASPECT_RATIO_NOT_ALLOWED can't be provided. This happens when asset spec contains more than one constraint and different criteria of different constraints are violated.", +"Image format is not allowed." +], +"type": "string" +}, +"incentiveError": { +"description": "The reasons for the incentive error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_INCENTIVE_ID" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The incentive ID is either invalid or not supported for the given country." +], +"type": "string" +}, +"internalError": { +"description": "An unexpected server-side error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INTERNAL_ERROR", +"ERROR_CODE_NOT_PUBLISHED", +"TRANSIENT_ERROR", +"DEADLINE_EXCEEDED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"API encountered unexpected internal error.", +"The intended error code doesn't exist in specified API version. It will be released in a future API version.", +"API encountered an unexpected transient error. The user should retry their request in these cases.", +"The request took longer than a deadline." +], +"type": "string" +}, +"invalidParameterError": { +"description": "The reasons for invalid parameter errors.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_CURRENCY_CODE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The specified currency code is invalid." +], +"type": "string" +}, +"invoiceError": { +"description": "The reasons for the invoice error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"YEAR_MONTH_TOO_OLD", +"NOT_INVOICED_CUSTOMER", +"BILLING_SETUP_NOT_APPROVED", +"BILLING_SETUP_NOT_ON_MONTHLY_INVOICING", +"NON_SERVING_CUSTOMER" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Cannot request invoices issued before 2019-01-01.", +"Cannot request invoices for customer who doesn't receive invoices.", +"Cannot request invoices for a non approved billing setup.", +"Cannot request invoices for a billing setup that is not on monthly invoicing.", +"Cannot request invoices for a non serving customer." +], +"type": "string" +}, +"keywordPlanAdGroupError": { +"description": "The reason for keyword plan ad group error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_NAME", +"DUPLICATE_NAME" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The keyword plan ad group name is missing, empty, longer than allowed limit or contains invalid chars.", +"The keyword plan ad group name is duplicate to an existing keyword plan AdGroup name or other keyword plan AdGroup name in the request." +], +"type": "string" +}, +"keywordPlanAdGroupKeywordError": { +"description": "The reason for keyword plan ad group keyword error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_KEYWORD_MATCH_TYPE", +"DUPLICATE_KEYWORD", +"KEYWORD_TEXT_TOO_LONG", +"KEYWORD_HAS_INVALID_CHARS", +"KEYWORD_HAS_TOO_MANY_WORDS", +"INVALID_KEYWORD_TEXT", +"NEGATIVE_KEYWORD_HAS_CPC_BID", +"NEW_BMM_KEYWORDS_NOT_ALLOWED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"A keyword or negative keyword has invalid match type.", +"A keyword or negative keyword with same text and match type already exists.", +"Keyword or negative keyword text exceeds the allowed limit.", +"Keyword or negative keyword text has invalid characters or symbols.", +"Keyword or negative keyword text has too many words.", +"Keyword or negative keyword has invalid text.", +"Cpc Bid set for negative keyword.", +"New broad match modifier (BMM) KpAdGroupKeywords are not allowed." +], +"type": "string" +}, +"keywordPlanCampaignError": { +"description": "The reason for keyword plan campaign error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_NAME", +"INVALID_LANGUAGES", +"INVALID_GEOS", +"DUPLICATE_NAME", +"MAX_GEOS_EXCEEDED", +"MAX_LANGUAGES_EXCEEDED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"A keyword plan campaign name is missing, empty, longer than allowed limit or contains invalid chars.", +"A keyword plan campaign contains one or more untargetable languages.", +"A keyword plan campaign contains one or more invalid geo targets.", +"The keyword plan campaign name is duplicate to an existing keyword plan campaign name or other keyword plan campaign name in the request.", +"The number of geo targets in the keyword plan campaign exceeds limits.", +"The number of languages in the keyword plan campaign exceeds limits." +], +"type": "string" +}, +"keywordPlanCampaignKeywordError": { +"description": "The reason for keyword plan campaign keyword error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CAMPAIGN_KEYWORD_IS_POSITIVE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Keyword plan campaign keyword is positive." +], +"type": "string" +}, +"keywordPlanError": { +"description": "The reason for keyword plan error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"BID_MULTIPLIER_OUT_OF_RANGE", +"BID_TOO_HIGH", +"BID_TOO_LOW", +"BID_TOO_MANY_FRACTIONAL_DIGITS", +"DAILY_BUDGET_TOO_LOW", +"DAILY_BUDGET_TOO_MANY_FRACTIONAL_DIGITS", +"INVALID_VALUE", +"KEYWORD_PLAN_HAS_NO_KEYWORDS", +"KEYWORD_PLAN_NOT_ENABLED", +"KEYWORD_PLAN_NOT_FOUND", +"MISSING_BID", +"MISSING_FORECAST_PERIOD", +"INVALID_FORECAST_DATE_RANGE", +"INVALID_NAME" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The plan's bid multiplier value is outside the valid range.", +"The plan's bid value is too high.", +"The plan's bid value is too low.", +"The plan's cpc bid is not a multiple of the minimum billable unit.", +"The plan's daily budget value is too low.", +"The plan's daily budget is not a multiple of the minimum billable unit.", +"The input has an invalid value.", +"The plan has no keyword.", +"The plan is not enabled and API cannot provide mutation, forecast or stats.", +"The requested plan cannot be found for providing forecast or stats.", +"The plan is missing a cpc bid.", +"The plan is missing required forecast_period field.", +"The plan's forecast_period has invalid forecast date range.", +"The plan's name is invalid." +], +"type": "string" +}, +"keywordPlanIdeaError": { +"description": "The reason for keyword idea error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"URL_CRAWL_ERROR", +"INVALID_VALUE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Error when crawling the input URL.", +"The input has an invalid value." +], +"type": "string" +}, +"labelError": { +"description": "The reason for the label error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CANNOT_APPLY_INACTIVE_LABEL", +"CANNOT_APPLY_LABEL_TO_DISABLED_AD_GROUP_CRITERION", +"CANNOT_APPLY_LABEL_TO_NEGATIVE_AD_GROUP_CRITERION", +"EXCEEDED_LABEL_LIMIT_PER_TYPE", +"INVALID_RESOURCE_FOR_MANAGER_LABEL", +"DUPLICATE_NAME", +"INVALID_LABEL_NAME", +"CANNOT_ATTACH_LABEL_TO_DRAFT", +"CANNOT_ATTACH_NON_MANAGER_LABEL_TO_CUSTOMER" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"An inactive label cannot be applied.", +"A label cannot be applied to a disabled ad group criterion.", +"A label cannot be applied to a negative ad group criterion.", +"Cannot apply more than 50 labels per resource.", +"Labels from a manager account cannot be applied to campaign, ad group, ad group ad, or ad group criterion resources.", +"Label names must be unique.", +"Label names cannot be empty.", +"Labels cannot be applied to a draft.", +"Labels not from a manager account cannot be applied to the customer resource." +], +"type": "string" +}, +"languageCodeError": { +"description": "The reasons for the language code error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"LANGUAGE_CODE_NOT_FOUND", +"INVALID_LANGUAGE_CODE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The input language code is not recognized.", +"The language code is not supported." +], +"type": "string" +}, +"listOperationError": { +"description": "An error with a list operation.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"REQUIRED_FIELD_MISSING", +"DUPLICATE_VALUES" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Field required in value is missing.", +"Duplicate or identical value is sent in multiple list operations." +], +"type": "string" +}, +"managerLinkError": { +"description": "The reasons for the manager link error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"ACCOUNTS_NOT_COMPATIBLE_FOR_LINKING", +"TOO_MANY_MANAGERS", +"TOO_MANY_INVITES", +"ALREADY_INVITED_BY_THIS_MANAGER", +"ALREADY_MANAGED_BY_THIS_MANAGER", +"ALREADY_MANAGED_IN_HIERARCHY", +"DUPLICATE_CHILD_FOUND", +"CLIENT_HAS_NO_ADMIN_USER", +"MAX_DEPTH_EXCEEDED", +"CYCLE_NOT_ALLOWED", +"TOO_MANY_ACCOUNTS", +"TOO_MANY_ACCOUNTS_AT_MANAGER", +"NON_OWNER_USER_CANNOT_MODIFY_LINK", +"SUSPENDED_ACCOUNT_CANNOT_ADD_CLIENTS", +"CLIENT_OUTSIDE_TREE", +"INVALID_STATUS_CHANGE", +"INVALID_CHANGE", +"CUSTOMER_CANNOT_MANAGE_SELF", +"CREATING_ENABLED_LINK_NOT_ALLOWED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The manager and client have incompatible account types.", +"Client is already linked to too many managers.", +"Manager has too many pending invitations.", +"Client is already invited by this manager.", +"The client is already managed by this manager.", +"Client is already managed in hierarchy.", +"Manager and sub-manager to be linked have duplicate client.", +"Client has no active user that can access the client account.", +"Adding this link would exceed the maximum hierarchy depth.", +"Adding this link will create a cycle.", +"Manager account has the maximum number of linked clients.", +"Parent manager account has the maximum number of linked clients.", +"The account is not authorized owner.", +"Your manager account is suspended, and you are no longer allowed to link to clients.", +"You are not allowed to move a client to a manager that is not under your current hierarchy.", +"The changed status for mutate link is invalid.", +"The change for mutate link is invalid.", +"You are not allowed to link a manager account to itself.", +"The link was created with status ACTIVE and not PENDING." +], +"type": "string" +}, +"mediaBundleError": { +"description": "The reasons for the media bundle error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"BAD_REQUEST", +"DOUBLECLICK_BUNDLE_NOT_ALLOWED", +"EXTERNAL_URL_NOT_ALLOWED", +"FILE_TOO_LARGE", +"GOOGLE_WEB_DESIGNER_ZIP_FILE_NOT_PUBLISHED", +"INVALID_INPUT", +"INVALID_MEDIA_BUNDLE", +"INVALID_MEDIA_BUNDLE_ENTRY", +"INVALID_MIME_TYPE", +"INVALID_PATH", +"INVALID_URL_REFERENCE", +"MEDIA_DATA_TOO_LARGE", +"MISSING_PRIMARY_MEDIA_BUNDLE_ENTRY", +"SERVER_ERROR", +"STORAGE_ERROR", +"SWIFFY_BUNDLE_NOT_ALLOWED", +"TOO_MANY_FILES", +"UNEXPECTED_SIZE", +"UNSUPPORTED_GOOGLE_WEB_DESIGNER_ENVIRONMENT", +"UNSUPPORTED_HTML5_FEATURE", +"URL_IN_MEDIA_BUNDLE_NOT_SSL_COMPLIANT", +"CUSTOM_EXIT_NOT_ALLOWED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"There was a problem with the request.", +"HTML5 ads using DoubleClick Studio created ZIP files are not supported.", +"Cannot reference URL external to the media bundle.", +"Media bundle file is too large.", +"ZIP file from Google Web Designer is not published.", +"Input was invalid.", +"There was a problem with the media bundle.", +"There was a problem with one or more of the media bundle entries.", +"The media bundle contains a file with an unknown mime type", +"The media bundle contain an invalid asset path.", +"HTML5 ad is trying to reference an asset not in .ZIP file", +"Media data is too large.", +"The media bundle contains no primary entry.", +"There was an error on the server.", +"The image could not be stored.", +"Media bundle created with the Swiffy tool is not allowed.", +"The media bundle contains too many files.", +"The media bundle is not of legal dimensions.", +"Google Web Designer not created for \"Google Ads\" environment.", +"Unsupported HTML5 feature in HTML5 asset.", +"URL in HTML5 entry is not ssl compliant.", +"Custom exits not allowed in HTML5 entry." +], +"type": "string" +}, +"mediaFileError": { +"description": "The reasons for the media file error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CANNOT_CREATE_STANDARD_ICON", +"CANNOT_SELECT_STANDARD_ICON_WITH_OTHER_TYPES", +"CANNOT_SPECIFY_MEDIA_FILE_ID_AND_DATA", +"DUPLICATE_MEDIA", +"EMPTY_FIELD", +"RESOURCE_REFERENCED_IN_MULTIPLE_OPS", +"FIELD_NOT_SUPPORTED_FOR_MEDIA_SUB_TYPE", +"INVALID_MEDIA_FILE_ID", +"INVALID_MEDIA_SUB_TYPE", +"INVALID_MEDIA_FILE_TYPE", +"INVALID_MIME_TYPE", +"INVALID_REFERENCE_ID", +"INVALID_YOU_TUBE_ID", +"MEDIA_FILE_FAILED_TRANSCODING", +"MEDIA_NOT_TRANSCODED", +"MEDIA_TYPE_DOES_NOT_MATCH_MEDIA_FILE_TYPE", +"NO_FIELDS_SPECIFIED", +"NULL_REFERENCE_ID_AND_MEDIA_ID", +"TOO_LONG", +"UNSUPPORTED_TYPE", +"YOU_TUBE_SERVICE_UNAVAILABLE", +"YOU_TUBE_VIDEO_HAS_NON_POSITIVE_DURATION", +"YOU_TUBE_VIDEO_NOT_FOUND" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Cannot create a standard icon type.", +"May only select Standard Icons alone.", +"Image contains both a media file ID and data.", +"A media file with given type and reference ID already exists.", +"A required field was not specified or is an empty string.", +"A media file may only be modified once per call.", +"Field is not supported for the media sub type.", +"The media file ID is invalid.", +"The media subtype is invalid.", +"The media file type is invalid.", +"The mimetype is invalid.", +"The media reference ID is invalid.", +"The YouTube video ID is invalid.", +"Media file has failed transcoding", +"Media file has not been transcoded.", +"The media type does not match the actual media file's type.", +"None of the fields have been specified.", +"One of reference ID or media file ID must be specified.", +"The string has too many characters.", +"The specified type is not supported.", +"YouTube is unavailable for requesting video data.", +"The YouTube video has a non positive duration.", +"The YouTube video ID is syntactically valid but the video was not found." +], +"type": "string" +}, +"mediaUploadError": { +"description": "The reasons for media uploading errors.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"FILE_TOO_BIG", +"UNPARSEABLE_IMAGE", +"ANIMATED_IMAGE_NOT_ALLOWED", +"FORMAT_NOT_ALLOWED", +"EXTERNAL_URL_NOT_ALLOWED", +"INVALID_URL_REFERENCE", +"MISSING_PRIMARY_MEDIA_BUNDLE_ENTRY", +"ANIMATED_VISUAL_EFFECT", +"ANIMATION_TOO_LONG", +"ASPECT_RATIO_NOT_ALLOWED", +"AUDIO_NOT_ALLOWED_IN_MEDIA_BUNDLE", +"CMYK_JPEG_NOT_ALLOWED", +"FLASH_NOT_ALLOWED", +"FRAME_RATE_TOO_HIGH", +"GOOGLE_WEB_DESIGNER_ZIP_FILE_NOT_PUBLISHED", +"IMAGE_CONSTRAINTS_VIOLATED", +"INVALID_MEDIA_BUNDLE", +"INVALID_MEDIA_BUNDLE_ENTRY", +"INVALID_MIME_TYPE", +"INVALID_PATH", +"LAYOUT_PROBLEM", +"MALFORMED_URL", +"MEDIA_BUNDLE_NOT_ALLOWED", +"MEDIA_BUNDLE_NOT_COMPATIBLE_TO_PRODUCT_TYPE", +"MEDIA_BUNDLE_REJECTED_BY_MULTIPLE_ASSET_SPECS", +"TOO_MANY_FILES_IN_MEDIA_BUNDLE", +"UNSUPPORTED_GOOGLE_WEB_DESIGNER_ENVIRONMENT", +"UNSUPPORTED_HTML5_FEATURE", +"URL_IN_MEDIA_BUNDLE_NOT_SSL_COMPLIANT", +"VIDEO_FILE_NAME_TOO_LONG", +"VIDEO_MULTIPLE_FILES_WITH_SAME_NAME", +"VIDEO_NOT_ALLOWED_IN_MEDIA_BUNDLE", +"CANNOT_UPLOAD_MEDIA_TYPE_THROUGH_API", +"DIMENSIONS_NOT_ALLOWED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The uploaded file is too big.", +"Image data is unparseable.", +"Animated images are not allowed.", +"The image or media bundle format is not allowed.", +"Cannot reference URL external to the media bundle.", +"HTML5 ad is trying to reference an asset not in .ZIP file.", +"The media bundle contains no primary entry.", +"Animation has disallowed visual effects.", +"Animation longer than the allowed 30 second limit.", +"The aspect ratio of the image does not match the expected aspect ratios provided in the asset spec.", +"Audio files are not allowed in bundle.", +"CMYK jpegs are not supported.", +"Flash movies are not allowed.", +"The frame rate of the video is higher than the allowed 5fps.", +"ZIP file from Google Web Designer is not published.", +"Image constraints are violated, but more details (like DIMENSIONS_NOT_ALLOWED or ASPECT_RATIO_NOT_ALLOWED) can not be provided. This happens when asset spec contains more than one constraint and criteria of different constraints are violated.", +"Media bundle data is unrecognizable.", +"There was a problem with one or more of the media bundle entries.", +"The asset has an invalid mime type.", +"The media bundle contains an invalid asset path.", +"Image has layout problem.", +"An asset had a URL reference that is malformed per RFC 1738 convention.", +"The uploaded media bundle format is not allowed.", +"The media bundle is not compatible with the asset spec product type. (For example, Gmail, dynamic remarketing, etc.)", +"A bundle being uploaded that is incompatible with multiple assets for different reasons.", +"The media bundle contains too many files.", +"Google Web Designer not created for \"Google Ads\" environment.", +"Unsupported HTML5 feature in HTML5 asset.", +"URL in HTML5 entry is not SSL compliant.", +"Video file name is longer than the 50 allowed characters.", +"Multiple videos with same name in a bundle.", +"Videos are not allowed in media bundle.", +"This type of media cannot be uploaded through the Google Ads API.", +"The dimensions of the image are not allowed." +], +"type": "string" +}, +"merchantCenterError": { +"description": "Container for enum describing possible merchant center errors.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"MERCHANT_ID_CANNOT_BE_ACCESSED", +"CUSTOMER_NOT_ALLOWED_FOR_SHOPPING_PERFORMANCE_MAX" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Merchant ID is either not found or not linked to the Google Ads customer.", +"Customer not allowlisted for Shopping in Performance Max Campaign." +], +"type": "string" +}, +"multiplierError": { +"description": "The reasons for the multiplier error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"MULTIPLIER_TOO_HIGH", +"MULTIPLIER_TOO_LOW", +"TOO_MANY_FRACTIONAL_DIGITS", +"MULTIPLIER_NOT_ALLOWED_FOR_BIDDING_STRATEGY", +"MULTIPLIER_NOT_ALLOWED_WHEN_BASE_BID_IS_MISSING", +"NO_MULTIPLIER_SPECIFIED", +"MULTIPLIER_CAUSES_BID_TO_EXCEED_DAILY_BUDGET", +"MULTIPLIER_CAUSES_BID_TO_EXCEED_MONTHLY_BUDGET", +"MULTIPLIER_CAUSES_BID_TO_EXCEED_CUSTOM_BUDGET", +"MULTIPLIER_CAUSES_BID_TO_EXCEED_MAX_ALLOWED_BID", +"BID_LESS_THAN_MIN_ALLOWED_BID_WITH_MULTIPLIER", +"MULTIPLIER_AND_BIDDING_STRATEGY_TYPE_MISMATCH" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Multiplier value is too high", +"Multiplier value is too low", +"Too many fractional digits", +"A multiplier cannot be set for this bidding strategy", +"A multiplier cannot be set when there is no base bid (for example, content max cpc)", +"A bid multiplier must be specified", +"Multiplier causes bid to exceed daily budget", +"Multiplier causes bid to exceed monthly budget", +"Multiplier causes bid to exceed custom budget", +"Multiplier causes bid to exceed maximum allowed bid", +"Multiplier causes bid to become less than the minimum bid allowed", +"Multiplier type (cpc versus cpm) needs to match campaign's bidding strategy" +], +"type": "string" +}, +"mutateError": { +"description": "An error with a mutate", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"RESOURCE_NOT_FOUND", +"ID_EXISTS_IN_MULTIPLE_MUTATES", +"INCONSISTENT_FIELD_VALUES", +"MUTATE_NOT_ALLOWED", +"RESOURCE_NOT_IN_GOOGLE_ADS", +"RESOURCE_ALREADY_EXISTS", +"RESOURCE_DOES_NOT_SUPPORT_VALIDATE_ONLY", +"OPERATION_DOES_NOT_SUPPORT_PARTIAL_FAILURE", +"RESOURCE_READ_ONLY", +"EU_POLITICAL_ADVERTISING_DECLARATION_REQUIRED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Requested resource was not found.", +"Cannot mutate the same resource twice in one request.", +"The field's contents don't match another field that represents the same data.", +"Mutates are not allowed for the requested resource.", +"The resource isn't in Google Ads. It belongs to another ads system.", +"The resource being created already exists.", +"This resource cannot be used with \"validate_only\".", +"This operation cannot be used with \"partial_failure\".", +"Attempt to write to read-only fields.", +"Mutates are generally not allowed if the customer contains non-exempt campaigns without the EU political advertising declaration." +], +"type": "string" +}, +"newResourceCreationError": { +"description": "The reasons for the new resource creation error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CANNOT_SET_ID_FOR_CREATE", +"DUPLICATE_TEMP_IDS", +"TEMP_ID_RESOURCE_HAD_ERRORS" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Do not set the id field while creating new resources.", +"Creating more than one resource with the same temp ID is not allowed.", +"Parent resource with specified temp ID failed validation, so no validation will be done for this child resource." +], +"type": "string" +}, +"notAllowlistedError": { +"description": "The reasons for the not allowlisted error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CUSTOMER_NOT_ALLOWLISTED_FOR_THIS_FEATURE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Customer is not allowlisted for accessing this feature." +], +"type": "string" +}, +"notEmptyError": { +"description": "The reasons for the not empty error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"EMPTY_LIST" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Empty list." +], +"type": "string" +}, +"nullError": { +"description": "The reasons for the null error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"NULL_CONTENT" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Specified list/container must not contain any null elements" +], +"type": "string" +}, +"offlineUserDataJobError": { +"description": "The reasons for the offline user data job error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_USER_LIST_ID", +"INVALID_USER_LIST_TYPE", +"NOT_ON_ALLOWLIST_FOR_USER_ID", +"INCOMPATIBLE_UPLOAD_KEY_TYPE", +"MISSING_USER_IDENTIFIER", +"INVALID_MOBILE_ID_FORMAT", +"TOO_MANY_USER_IDENTIFIERS", +"NOT_ON_ALLOWLIST_FOR_STORE_SALES_DIRECT", +"NOT_ON_ALLOWLIST_FOR_UNIFIED_STORE_SALES", +"INVALID_PARTNER_ID", +"INVALID_ENCODING", +"INVALID_COUNTRY_CODE", +"INCOMPATIBLE_USER_IDENTIFIER", +"FUTURE_TRANSACTION_TIME", +"INVALID_CONVERSION_ACTION", +"MOBILE_ID_NOT_SUPPORTED", +"INVALID_OPERATION_ORDER", +"CONFLICTING_OPERATION", +"EXTERNAL_UPDATE_ID_ALREADY_EXISTS", +"JOB_ALREADY_STARTED", +"REMOVE_NOT_SUPPORTED", +"REMOVE_ALL_NOT_SUPPORTED", +"INVALID_SHA256_FORMAT", +"CUSTOM_KEY_DISABLED", +"CUSTOM_KEY_NOT_PREDEFINED", +"CUSTOM_KEY_NOT_SET", +"CUSTOMER_NOT_ACCEPTED_CUSTOMER_DATA_TERMS", +"ATTRIBUTES_NOT_APPLICABLE_FOR_CUSTOMER_MATCH_USER_LIST", +"LIFETIME_VALUE_BUCKET_NOT_IN_RANGE", +"INCOMPATIBLE_USER_IDENTIFIER_FOR_ATTRIBUTES", +"FUTURE_TIME_NOT_ALLOWED", +"LAST_PURCHASE_TIME_LESS_THAN_ACQUISITION_TIME", +"CUSTOMER_IDENTIFIER_NOT_ALLOWED", +"INVALID_ITEM_ID", +"FIRST_PURCHASE_TIME_GREATER_THAN_LAST_PURCHASE_TIME", +"INVALID_LIFECYCLE_STAGE", +"INVALID_EVENT_VALUE", +"EVENT_ATTRIBUTE_ALL_FIELDS_ARE_REQUIRED", +"OPERATION_LEVEL_CONSENT_PROVIDED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The user list ID provided for the job is invalid.", +"Type of the user list is not applicable for the job.", +"Customer is not allowisted for using user ID in upload data.", +"Upload data is not compatible with the upload key type of the associated user list.", +"The user identifier is missing valid data.", +"The mobile ID is malformed.", +"Maximum number of user identifiers allowed per request is 100,000 and per operation is 20.", +"Customer is not on the allow-list for store sales direct data.", +"Customer is not on the allow-list for unified store sales data.", +"The partner ID in store sales direct metadata is invalid.", +"The data in user identifier should not be encoded.", +"The country code is invalid.", +"Incompatible user identifier when using third_party_user_id for store sales direct first party data or not using third_party_user_id for store sales third party data.", +"A transaction time in the future is not allowed.", +"The conversion_action specified in transaction_attributes is used to report conversions to a conversion action configured in Google Ads. This error indicates there is no such conversion action in the account.", +"Mobile ID is not supported for store sales direct data.", +"When a remove-all operation is provided, it has to be the first operation of the operation list.", +"Mixing creation and removal of offline data in the same job is not allowed.", +"The external update ID already exists.", +"Once the upload job is started, new operations cannot be added.", +"Remove operation is not allowed for store sales direct updates.", +"Remove-all is not supported for certain offline user data job types.", +"The SHA256 encoded value is malformed.", +"The custom key specified is not enabled for the unified store sales upload.", +"The custom key specified is not predefined through the Google Ads UI.", +"The custom key specified is not set in the upload.", +"The customer has not accepted the customer data terms in the conversion settings page.", +"User attributes cannot be uploaded into a user list.", +"Lifetime bucket value must be a number from 0 to 10; 0 is only accepted for remove operations", +"Identifiers not supported for Customer Match attributes. User attributes can only be provided with contact info (email, phone, address) user identifiers.", +"A time in the future is not allowed.", +"Last purchase date time cannot be less than acquisition date time.", +"Only emails are accepted as user identifiers for shopping loyalty match. {-- api.dev/not-precedent: The identifier is not limited to ids, but also include other user info eg. phone numbers.}", +"Provided item ID is invalid.", +"First purchase date time cannot be greater than the last purchase date time.", +"Provided lifecycle stage is invalid.", +"The event value of the Customer Match user attribute is invalid.", +"All the fields are not present in the EventAttribute of the Customer Match.", +"Consent was provided at the operation level for an OfflineUserDataJobType that expects it at the job level. The provided operation-level consent will be ignored." +], +"type": "string" +}, +"operationAccessDeniedError": { +"description": "The reasons for the operation access denied error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"ACTION_NOT_PERMITTED", +"CREATE_OPERATION_NOT_PERMITTED", +"REMOVE_OPERATION_NOT_PERMITTED", +"UPDATE_OPERATION_NOT_PERMITTED", +"MUTATE_ACTION_NOT_PERMITTED_FOR_CLIENT", +"OPERATION_NOT_PERMITTED_FOR_CAMPAIGN_TYPE", +"CREATE_AS_REMOVED_NOT_PERMITTED", +"OPERATION_NOT_PERMITTED_FOR_REMOVED_RESOURCE", +"OPERATION_NOT_PERMITTED_FOR_AD_GROUP_TYPE", +"MUTATE_NOT_PERMITTED_FOR_CUSTOMER" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Unauthorized invocation of a service's method (get, mutate, etc.)", +"Unauthorized CREATE operation in invoking a service's mutate method.", +"Unauthorized REMOVE operation in invoking a service's mutate method.", +"Unauthorized UPDATE operation in invoking a service's mutate method.", +"A mutate action is not allowed on this resource, from this client.", +"This operation is not permitted on this campaign type", +"A CREATE operation may not set status to REMOVED.", +"This operation is not allowed because the resource is removed.", +"This operation is not permitted on this ad group type.", +"The mutate is not allowed for this customer." +], +"type": "string" +}, +"operatorError": { +"description": "The reasons for the operator error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"OPERATOR_NOT_SUPPORTED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Operator not supported." +], +"type": "string" +}, +"partialFailureError": { +"description": "The reasons for the mutate job error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"PARTIAL_FAILURE_MODE_REQUIRED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The partial failure field was false in the request. This method requires this field be set to true." +], +"type": "string" +}, +"paymentsAccountError": { +"description": "The reasons for errors in payments accounts service", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"NOT_SUPPORTED_FOR_MANAGER_CUSTOMER" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Manager customers are not supported for payments account service." +], +"type": "string" +}, +"policyFindingError": { +"description": "The reasons for the policy finding error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"POLICY_FINDING", +"POLICY_TOPIC_NOT_FOUND" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The resource has been disapproved since the policy summary includes policy topics of type PROHIBITED.", +"The given policy topic does not exist." +], +"type": "string" +}, +"policyValidationParameterError": { +"description": "The reasons for the policy validation parameter error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"UNSUPPORTED_AD_TYPE_FOR_IGNORABLE_POLICY_TOPICS", +"UNSUPPORTED_AD_TYPE_FOR_EXEMPT_POLICY_VIOLATION_KEYS", +"CANNOT_SET_BOTH_IGNORABLE_POLICY_TOPICS_AND_EXEMPT_POLICY_VIOLATION_KEYS" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Ignorable policy topics are not supported for the ad type.", +"Exempt policy violation keys are not supported for the ad type.", +"Cannot set ignorable policy topics and exempt policy violation keys in the same policy violation parameter." +], +"type": "string" +}, +"policyViolationError": { +"description": "The reasons for the policy violation error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"POLICY_ERROR" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"A policy was violated. See PolicyViolationDetails for more detail." +], +"type": "string" +}, +"productLinkError": { +"description": "The reasons for the product link error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_OPERATION", +"CREATION_NOT_PERMITTED", +"INVITATION_EXISTS", +"LINK_EXISTS" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The requested operation is invalid. For example, you are not allowed to remove a link from a partner account.", +"The creation request is not permitted.", +"A link cannot be created because a pending link already exists.", +"A link cannot be created because an active link already exists." +], +"type": "string" +}, +"productLinkInvitationError": { +"description": "The reasons for the product link invitation error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_STATUS", +"PERMISSION_DENIED", +"NO_INVITATION_REQUIRED", +"CUSTOMER_NOT_PERMITTED_TO_CREATE_INVITATION" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in the version.", +"The invitation status is invalid.", +"The customer doesn't have the permission to perform this action", +"An invitation could not be created, since the user already has admin access to the invited account. Use the ProductLinkService to directly create an active link.", +"The customer is not permitted to create the invitation." +], +"type": "string" +}, +"queryError": { +"description": "An error with the query", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"QUERY_ERROR", +"BAD_ENUM_CONSTANT", +"BAD_ESCAPE_SEQUENCE", +"BAD_FIELD_NAME", +"BAD_LIMIT_VALUE", +"BAD_NUMBER", +"BAD_OPERATOR", +"BAD_PARAMETER_NAME", +"BAD_PARAMETER_VALUE", +"BAD_RESOURCE_TYPE_IN_FROM_CLAUSE", +"BAD_SYMBOL", +"BAD_VALUE", +"DATE_RANGE_TOO_WIDE", +"DATE_RANGE_TOO_NARROW", +"EXPECTED_AND", +"EXPECTED_BY", +"EXPECTED_DIMENSION_FIELD_IN_SELECT_CLAUSE", +"EXPECTED_FILTERS_ON_DATE_RANGE", +"EXPECTED_FROM", +"EXPECTED_LIST", +"EXPECTED_REFERENCED_FIELD_IN_SELECT_CLAUSE", +"EXPECTED_SELECT", +"EXPECTED_SINGLE_VALUE", +"EXPECTED_VALUE_WITH_BETWEEN_OPERATOR", +"INVALID_DATE_FORMAT", +"MISALIGNED_DATE_FOR_FILTER", +"INVALID_STRING_VALUE", +"INVALID_VALUE_WITH_BETWEEN_OPERATOR", +"INVALID_VALUE_WITH_DURING_OPERATOR", +"INVALID_VALUE_WITH_LIKE_OPERATOR", +"OPERATOR_FIELD_MISMATCH", +"PROHIBITED_EMPTY_LIST_IN_CONDITION", +"PROHIBITED_ENUM_CONSTANT", +"PROHIBITED_FIELD_COMBINATION_IN_SELECT_CLAUSE", +"PROHIBITED_FIELD_IN_ORDER_BY_CLAUSE", +"PROHIBITED_FIELD_IN_SELECT_CLAUSE", +"PROHIBITED_FIELD_IN_WHERE_CLAUSE", +"PROHIBITED_RESOURCE_TYPE_IN_FROM_CLAUSE", +"PROHIBITED_RESOURCE_TYPE_IN_SELECT_CLAUSE", +"PROHIBITED_RESOURCE_TYPE_IN_WHERE_CLAUSE", +"PROHIBITED_METRIC_IN_SELECT_OR_WHERE_CLAUSE", +"PROHIBITED_SEGMENT_IN_SELECT_OR_WHERE_CLAUSE", +"PROHIBITED_SEGMENT_WITH_METRIC_IN_SELECT_OR_WHERE_CLAUSE", +"PROHIBITED_FIELD_OR_SEGMENT_WITH_METRIC", +"LIMIT_VALUE_TOO_LOW", +"PROHIBITED_NEWLINE_IN_STRING", +"PROHIBITED_VALUE_COMBINATION_IN_LIST", +"PROHIBITED_VALUE_COMBINATION_WITH_BETWEEN_OPERATOR", +"STRING_NOT_TERMINATED", +"TOO_MANY_SEGMENTS", +"UNEXPECTED_END_OF_QUERY", +"UNEXPECTED_FROM_CLAUSE", +"UNRECOGNIZED_FIELD", +"UNEXPECTED_INPUT", +"REQUESTED_METRICS_FOR_MANAGER", +"FILTER_HAS_TOO_MANY_VALUES", +"REQUIRED_SEGMENT_FIELD_MISSING" +], +"enumDescriptions": [ +"Name unspecified.", +"The received error code is not known in this version.", +"Returned if all other query error reasons are not applicable.", +"A condition used in the query references an invalid enum constant.", +"Query contains an invalid escape sequence.", +"Field name is invalid.", +"Limit value is invalid (for example, not a number)", +"Encountered number can not be parsed.", +"Invalid operator encountered.", +"Parameter unknown or not supported.", +"Parameter have invalid value.", +"Invalid resource type was specified in the FROM clause.", +"Non-ASCII symbol encountered outside of strings.", +"Value is invalid.", +"Date filters fail to restrict date to a range smaller than 31 days. Applicable if the query is segmented by date.", +"Filters on date/week/month/quarter have a start date after end date.", +"Expected AND between values with BETWEEN operator.", +"Expecting ORDER BY to have BY.", +"There was no dimension field selected.", +"Missing filters on date related fields.", +"Missing FROM clause.", +"The operator used in the conditions requires the value to be a list.", +"Fields used in WHERE or ORDER BY clauses are missing from the SELECT clause.", +"SELECT is missing at the beginning of query.", +"A list was passed as a value to a condition whose operator expects a single value.", +"Missing one or both values with BETWEEN operator.", +"Invalid date format. Expected 'YYYY-MM-DD'.", +"Misaligned date value for the filter. The date should be the start of a week/month/quarter if the filtered field is segments.week/segments.month/segments.quarter.", +"Value passed was not a string when it should have been. For example, it was a number or unquoted literal.", +"A String value passed to the BETWEEN operator does not parse as a date.", +"The value passed to the DURING operator is not a Date range literal", +"A value was passed to the LIKE operator.", +"An operator was provided that is inapplicable to the field being filtered.", +"A Condition was found with an empty list.", +"A condition used in the query references an unsupported enum constant.", +"Fields that are not allowed to be selected together were included in the SELECT clause.", +"A field that is not orderable was included in the ORDER BY clause.", +"A field that is not selectable was included in the SELECT clause.", +"A field that is not filterable was included in the WHERE clause.", +"Resource type specified in the FROM clause is not supported by this service.", +"A field that comes from an incompatible resource was included in the SELECT clause.", +"A field that comes from an incompatible resource was included in the WHERE clause.", +"A metric incompatible with the main resource or other selected segmenting resources was included in the SELECT or WHERE clause.", +"A segment incompatible with the main resource or other selected segmenting resources was included in the SELECT or WHERE clause.", +"A segment in the SELECT clause is incompatible with a metric in the SELECT or WHERE clause.", +"A metric may not be selected with one of the selected resource fields, or segmented by one of the selected segment fields.", +"The value passed to the limit clause is too low.", +"Query has a string containing a newline character.", +"List contains values of different types.", +"The values passed to the BETWEEN operator are not of the same type.", +"Query contains unterminated string.", +"Too many segments are specified in SELECT clause.", +"Query is incomplete and cannot be parsed.", +"FROM clause cannot be specified in this query.", +"Query contains one or more unrecognized fields.", +"Query has an unexpected extra part.", +"Metrics cannot be requested for a manager account. To retrieve metrics, issue separate requests against each client account under the manager account.", +"The number of values (right-hand-side operands) in a filter exceeds the limit.", +"Required segment field is missing." +], +"type": "string" +}, +"quotaError": { +"description": "An error with the amount of quota remaining.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"RESOURCE_EXHAUSTED", +"ACCESS_PROHIBITED", +"RESOURCE_TEMPORARILY_EXHAUSTED", +"EXCESSIVE_SHORT_TERM_QUERY_RESOURCE_CONSUMPTION", +"EXCESSIVE_LONG_TERM_QUERY_RESOURCE_CONSUMPTION", +"PAYMENTS_PROFILE_ACTIVATION_RATE_LIMIT_EXCEEDED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Too many requests.", +"Access is prohibited.", +"Too many requests in a short amount of time.", +"Too many expensive requests from query pattern over a short amount of time.", +"Too many expensive requests from query pattern over an extended duration of time.", +"To activate ad serving in a customer account, it has to be linked with a payment profile (also known as a Billing Customer Number, or BCN), which is then billed for the costs incurred by that customer account. This error will be thrown if too many customer accounts are activated in a short period of time for the same payment profile. Once this rate limit is exceeded, the customer should wait for a week before trying again, or contact Google Ads customer support to reset the rate limits. See https://support.google.com/google-ads/answer/6372658 to learn more about this limit." +], +"type": "string" +}, +"rangeError": { +"description": "The reasons for the range error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"TOO_LOW", +"TOO_HIGH" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Too low.", +"Too high." +], +"type": "string" +}, +"reachPlanError": { +"description": "The reasons for the reach plan error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"NOT_FORECASTABLE_MISSING_RATE", +"NOT_FORECASTABLE_NOT_ENOUGH_INVENTORY", +"NOT_FORECASTABLE_ACCOUNT_NOT_ENABLED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Not forecastable due to missing rate card data.", +"Not forecastable due to not enough inventory.", +"Not forecastable due to account not being enabled." +], +"type": "string" +}, +"recommendationError": { +"description": "The reasons for error in applying a recommendation", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"BUDGET_AMOUNT_TOO_SMALL", +"BUDGET_AMOUNT_TOO_LARGE", +"INVALID_BUDGET_AMOUNT", +"POLICY_ERROR", +"INVALID_BID_AMOUNT", +"ADGROUP_KEYWORD_LIMIT", +"RECOMMENDATION_ALREADY_APPLIED", +"RECOMMENDATION_INVALIDATED", +"TOO_MANY_OPERATIONS", +"NO_OPERATIONS", +"DIFFERENT_TYPES_NOT_SUPPORTED", +"DUPLICATE_RESOURCE_NAME", +"RECOMMENDATION_ALREADY_DISMISSED", +"INVALID_APPLY_REQUEST", +"RECOMMENDATION_TYPE_APPLY_NOT_SUPPORTED", +"INVALID_MULTIPLIER", +"ADVERTISING_CHANNEL_TYPE_GENERATE_NOT_SUPPORTED", +"RECOMMENDATION_TYPE_GENERATE_NOT_SUPPORTED", +"RECOMMENDATION_TYPES_CANNOT_BE_EMPTY", +"CAMPAIGN_BUDGET_RECOMMENDATION_TYPE_REQUIRES_BIDDING_INFO", +"CAMPAIGN_BUDGET_RECOMMENDATION_TYPE_REQUIRES_BIDDING_STRATEGY_TYPE", +"CAMPAIGN_BUDGET_RECOMMENDATION_TYPE_REQUIRES_ASSET_GROUP_INFO", +"CAMPAIGN_BUDGET_RECOMMENDATION_TYPE_REQUIRES_ASSET_GROUP_INFO_WITH_FINAL_URL", +"CAMPAIGN_BUDGET_RECOMMENDATION_TYPE_REQUIRES_COUNTRY_CODES_FOR_SEARCH_CHANNEL", +"CAMPAIGN_BUDGET_RECOMMENDATION_TYPE_INVALID_COUNTRY_CODE_FOR_SEARCH_CHANNEL", +"CAMPAIGN_BUDGET_RECOMMENDATION_TYPE_REQUIRES_LANGUAGE_CODES_FOR_SEARCH_CHANNEL", +"CAMPAIGN_BUDGET_RECOMMENDATION_TYPE_REQUIRES_EITHER_POSITIVE_OR_NEGATIVE_LOCATION_IDS_FOR_SEARCH_CHANNEL", +"CAMPAIGN_BUDGET_RECOMMENDATION_TYPE_REQUIRES_AD_GROUP_INFO_FOR_SEARCH_CHANNEL", +"CAMPAIGN_BUDGET_RECOMMENDATION_TYPE_REQUIRES_KEYWORDS_FOR_SEARCH_CHANNEL", +"CAMPAIGN_BUDGET_RECOMMENDATION_TYPE_WITH_CHANNEL_TYPE_SEARCH_AND_BIDDING_STRATEGY_TYPE_TARGET_IMPRESSION_SHARE_REQUIRES_LOCATION", +"CAMPAIGN_BUDGET_RECOMMENDATION_TYPE_WITH_CHANNEL_TYPE_SEARCH_AND_BIDDING_STRATEGY_TYPE_TARGET_IMPRESSION_SHARE_REQUIRES_TARGET_IMPRESSION_SHARE_MICROS", +"CAMPAIGN_BUDGET_RECOMMENDATION_TYPE_TARGET_IMPRESSION_SHARE_MICROS_BETWEEN_1_AND_1000000", +"CAMPAIGN_BUDGET_RECOMMENDATION_TYPE_WITH_CHANNEL_TYPE_SEARCH_AND_BIDDING_STRATEGY_TYPE_TARGET_IMPRESSION_SHARE_REQUIRES_TARGET_IMPRESSION_SHARE_INFO", +"MERCHANT_CENTER_ACCOUNT_ID_NOT_SUPPORTED_ADVERTISING_CHANNEL_TYPE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The specified budget amount is too low for example, lower than minimum currency unit or lower than ad group minimum cost-per-click.", +"The specified budget amount is too large.", +"The specified budget amount is not a valid amount, for example, not a multiple of minimum currency unit.", +"The specified keyword or ad violates ad policy.", +"The specified bid amount is not valid, for example, too many fractional digits, or negative amount.", +"The number of keywords in ad group have reached the maximum allowed.", +"The recommendation requested to apply has already been applied.", +"The recommendation requested to apply has been invalidated.", +"The number of operations in a single request exceeds the maximum allowed.", +"There are no operations in the request.", +"Operations with multiple recommendation types are not supported when partial failure mode is not enabled.", +"Request contains multiple operations with the same resource_name.", +"The recommendation requested to dismiss has already been dismissed.", +"The recommendation apply request was malformed and invalid.", +"The type of recommendation requested to apply is not supported.", +"The target multiplier specified is invalid.", +"The passed in advertising_channel_type is not supported.", +"The passed in recommendation_type is not supported.", +"One or more recommendation_types need to be passed into the generate recommendations request.", +"Bidding info is required for the CAMPAIGN_BUDGET recommendation type.", +"Bidding strategy type is required for the CAMPAIGN_BUDGET recommendation type.", +"Asset group info is required for the campaign budget recommendation type.", +"Asset group info with final url is required for the CAMPAIGN_BUDGET recommendation type.", +"Country codes are required for the CAMPAIGN_BUDGET recommendation type for SEARCH channel.", +"Country code is invalid for the CAMPAIGN_BUDGET recommendation type for SEARCH channel.", +"Language codes are required for the CAMPAIGN_BUDGET recommendation type for SEARCH channel.", +"Either positive or negative location ids are required for the CAMPAIGN_BUDGET recommendation type for SEARCH channel.", +"Ad group info is required for the CAMPAIGN_BUDGET recommendation type for SEARCH channel.", +"Keywords are required for the CAMPAIGN_BUDGET recommendation type for SEARCH channel.", +"Location is required for the CAMPAIGN_BUDGET recommendation type for bidding strategy type TARGET_IMPRESSION_SHARE.", +"Target impression share micros are required for the CAMPAIGN_BUDGET recommendation type for bidding strategy type TARGET_IMPRESSION_SHARE.", +"Target impression share micros are required to be between 1 and 1000000 for the CAMPAIGN_BUDGET recommendation type for bidding strategy type TARGET_IMPRESSION_SHARE.", +"Target impression share info is required for the CAMPAIGN_BUDGET recommendation type for bidding strategy type TARGET_IMPRESSION_SHARE.", +"Merchant Center Account ID is only supported for advertising_channel_type PERFORMANCE_MAX." +], +"type": "string" +}, +"recommendationSubscriptionError": { +"description": "The reasons for the recommendation subscription error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version." +], +"type": "string" +}, +"regionCodeError": { +"description": "The reasons for the region code error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_REGION_CODE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Invalid region code." +], +"type": "string" +}, +"requestError": { +"description": "An error caused by the request", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"RESOURCE_NAME_MISSING", +"RESOURCE_NAME_MALFORMED", +"BAD_RESOURCE_ID", +"INVALID_CUSTOMER_ID", +"OPERATION_REQUIRED", +"RESOURCE_NOT_FOUND", +"INVALID_PAGE_TOKEN", +"EXPIRED_PAGE_TOKEN", +"INVALID_PAGE_SIZE", +"PAGE_SIZE_NOT_SUPPORTED", +"REQUIRED_FIELD_MISSING", +"IMMUTABLE_FIELD", +"TOO_MANY_MUTATE_OPERATIONS", +"CANNOT_BE_EXECUTED_BY_MANAGER_ACCOUNT", +"CANNOT_MODIFY_FOREIGN_FIELD", +"INVALID_ENUM_VALUE", +"DEVELOPER_TOKEN_PARAMETER_MISSING", +"LOGIN_CUSTOMER_ID_PARAMETER_MISSING", +"VALIDATE_ONLY_REQUEST_HAS_PAGE_TOKEN", +"CANNOT_RETURN_SUMMARY_ROW_FOR_REQUEST_WITHOUT_METRICS", +"CANNOT_RETURN_SUMMARY_ROW_FOR_VALIDATE_ONLY_REQUESTS", +"INCONSISTENT_RETURN_SUMMARY_ROW_VALUE", +"TOTAL_RESULTS_COUNT_NOT_ORIGINALLY_REQUESTED", +"RPC_DEADLINE_TOO_SHORT", +"UNSUPPORTED_VERSION", +"CLOUD_PROJECT_NOT_FOUND" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Resource name is required for this request.", +"Resource name provided is malformed.", +"Resource name provided is malformed.", +"Customer ID is invalid.", +"Mutate operation should have either create, update, or remove specified.", +"Requested resource not found.", +"Next page token specified in user request is invalid.", +"Next page token specified in user request has expired.", +"Page size specified in user request is invalid.", +"Setting the page size is not supported, and will be unavailable in a future version.", +"Required field is missing.", +"The field cannot be modified because it's immutable. It's also possible that the field can be modified using 'create' operation but not 'update'.", +"Received too many entries in request.", +"Request cannot be executed by a manager account.", +"Mutate request was attempting to modify a readonly field. For instance, Budget fields can be requested for Ad Group, but are read-only for adGroups:mutate.", +"Enum value is not permitted.", +"The developer-token parameter is required for all requests.", +"The login-customer-id parameter is required for this request.", +"page_token is set in the validate only request", +"return_summary_row cannot be enabled if request did not select any metrics field.", +"return_summary_row should not be enabled for validate only requests.", +"return_summary_row parameter value should be the same between requests with page_token field set and their original request.", +"The total results count cannot be returned if it was not requested in the original request.", +"Deadline specified by the client was too short.", +"This API version has been sunset and is no longer supported.", +"The Google Cloud project in the request was not found." +], +"type": "string" +}, +"resourceAccessDeniedError": { +"description": "The reasons for the resource access denied error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"WRITE_ACCESS_DENIED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"User did not have write access." +], +"type": "string" +}, +"resourceCountLimitExceededError": { +"description": "The reasons for the resource count limit exceeded error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"ACCOUNT_LIMIT", +"CAMPAIGN_LIMIT", +"ADGROUP_LIMIT", +"AD_GROUP_AD_LIMIT", +"AD_GROUP_CRITERION_LIMIT", +"SHARED_SET_LIMIT", +"MATCHING_FUNCTION_LIMIT", +"RESPONSE_ROW_LIMIT_EXCEEDED", +"RESOURCE_LIMIT" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Indicates that this request would exceed the number of allowed resources for the Google Ads account. The exact resource type and limit being checked can be inferred from accountLimitType.", +"Indicates that this request would exceed the number of allowed resources in a Campaign. The exact resource type and limit being checked can be inferred from accountLimitType, and the numeric id of the Campaign involved is given by enclosingId.", +"Indicates that this request would exceed the number of allowed resources in an ad group. The exact resource type and limit being checked can be inferred from accountLimitType, and the numeric id of the ad group involved is given by enclosingId.", +"Indicates that this request would exceed the number of allowed resources in an ad group ad. The exact resource type and limit being checked can be inferred from accountLimitType, and the enclosingId contains the ad group id followed by the ad id, separated by a single comma (,).", +"Indicates that this request would exceed the number of allowed resources in an ad group criterion. The exact resource type and limit being checked can be inferred from accountLimitType, and the enclosingId contains the ad group id followed by the criterion id, separated by a single comma (,).", +"Indicates that this request would exceed the number of allowed resources in this shared set. The exact resource type and limit being checked can be inferred from accountLimitType, and the numeric id of the shared set involved is given by enclosingId.", +"Exceeds a limit related to a matching function.", +"The response for this request would exceed the maximum number of rows that can be returned.", +"This request would exceed a limit on the number of allowed resources. The details of which type of limit was exceeded will eventually be returned in ErrorDetails." +], +"type": "string" +}, +"searchTermInsightError": { +"description": "The reasons for the Search term insight error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"FILTERING_NOT_ALLOWED_WITH_SEGMENTS", +"LIMIT_NOT_ALLOWED_WITH_SEGMENTS", +"MISSING_FIELD_IN_SELECT_CLAUSE", +"REQUIRES_FILTER_BY_SINGLE_RESOURCE", +"SORTING_NOT_ALLOWED_WITH_SEGMENTS", +"SUMMARY_ROW_NOT_ALLOWED_WITH_SEGMENTS" +], +"enumDescriptions": [ +"Name unspecified.", +"The received error code is not known in this version.", +"Search term insights cannot be filtered by metrics when segmenting.", +"Search term insights cannot have a LIMIT when segmenting.", +"A selected field requires another field to be selected with it.", +"A selected field/resource requires filtering by a single resource.", +"Search term insights cannot be sorted when segmenting.", +"Search term insights cannot have a summary row when segmenting." +], +"type": "string" +}, +"settingError": { +"description": "The reasons for the setting error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"SETTING_TYPE_IS_NOT_AVAILABLE", +"SETTING_TYPE_IS_NOT_COMPATIBLE_WITH_CAMPAIGN", +"TARGETING_SETTING_CONTAINS_INVALID_CRITERION_TYPE_GROUP", +"TARGETING_SETTING_DEMOGRAPHIC_CRITERION_TYPE_GROUPS_MUST_BE_SET_TO_TARGET_ALL", +"TARGETING_SETTING_CANNOT_CHANGE_TARGET_ALL_TO_FALSE_FOR_DEMOGRAPHIC_CRITERION_TYPE_GROUP", +"DYNAMIC_SEARCH_ADS_SETTING_AT_LEAST_ONE_FEED_ID_MUST_BE_PRESENT", +"DYNAMIC_SEARCH_ADS_SETTING_CONTAINS_INVALID_DOMAIN_NAME", +"DYNAMIC_SEARCH_ADS_SETTING_CONTAINS_SUBDOMAIN_NAME", +"DYNAMIC_SEARCH_ADS_SETTING_CONTAINS_INVALID_LANGUAGE_CODE", +"TARGET_ALL_IS_NOT_ALLOWED_FOR_PLACEMENT_IN_SEARCH_CAMPAIGN", +"SETTING_VALUE_NOT_COMPATIBLE_WITH_CAMPAIGN", +"BID_ONLY_IS_NOT_ALLOWED_TO_BE_MODIFIED_WITH_CUSTOMER_MATCH_TARGETING" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The campaign setting is not available for this Google Ads account.", +"The setting is not compatible with the campaign.", +"The supplied TargetingSetting contains an invalid CriterionTypeGroup. See CriterionTypeGroup documentation for CriterionTypeGroups allowed in Campaign or AdGroup TargetingSettings.", +"TargetingSetting must not explicitly set any of the Demographic CriterionTypeGroups (AGE_RANGE, GENDER, PARENT, INCOME_RANGE) to false (it's okay to not set them at all, in which case the system will set them to true automatically).", +"TargetingSetting cannot change any of the Demographic CriterionTypeGroups (AGE_RANGE, GENDER, PARENT, INCOME_RANGE) from true to false.", +"At least one feed id should be present.", +"The supplied DynamicSearchAdsSetting contains an invalid domain name.", +"The supplied DynamicSearchAdsSetting contains a subdomain name.", +"The supplied DynamicSearchAdsSetting contains an invalid language code.", +"TargetingSettings in search campaigns should not have CriterionTypeGroup.PLACEMENT set to targetAll.", +"The setting value is not compatible with the campaign type.", +"Switching from observation setting to targeting setting is not allowed for Customer Match lists. See https://support.google.com/google-ads/answer/6299717." +], +"type": "string" +}, +"shareablePreviewError": { +"description": "The reasons for the shareable preview error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"TOO_MANY_ASSET_GROUPS_IN_REQUEST", +"ASSET_GROUP_DOES_NOT_EXIST_UNDER_THIS_CUSTOMER" +], +"enumDescriptions": [ +"Enum unspecified.", +"Used for return value only. Represents value unknown in this version.", +"The maximum of 10 asset groups was exceeded.", +"asset group does not exist under this customer." +], +"type": "string" +}, +"sharedCriterionError": { +"description": "The reasons for the shared criterion error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CRITERION_TYPE_NOT_ALLOWED_FOR_SHARED_SET_TYPE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The criterion is not appropriate for the shared set type." +], +"type": "string" +}, +"sharedSetError": { +"description": "The reasons for the shared set error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CUSTOMER_CANNOT_CREATE_SHARED_SET_OF_THIS_TYPE", +"DUPLICATE_NAME", +"SHARED_SET_REMOVED", +"SHARED_SET_IN_USE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The customer cannot create this type of shared set.", +"A shared set with this name already exists.", +"Removed shared sets cannot be mutated.", +"The shared set cannot be removed because it is in use." +], +"type": "string" +}, +"shoppingProductError": { +"description": "The reasons for error in querying shopping product.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"MISSING_CAMPAIGN_FILTER", +"MISSING_AD_GROUP_FILTER", +"UNSUPPORTED_DATE_SEGMENTATION" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"A filter on the `campaign` resource name is missing.", +"A filter on the `ad_group` resource name is missing.", +"Date segmentation is not supported." +], +"type": "string" +}, +"sizeLimitError": { +"description": "The reasons for the size limit error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"REQUEST_SIZE_LIMIT_EXCEEDED", +"RESPONSE_SIZE_LIMIT_EXCEEDED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The number of entries in the request exceeds the system limit, or the contents of the operations exceed transaction limits due to their size or complexity. Try reducing the number of entries per request.", +"The number of entries in the response exceeds the system limit." +], +"type": "string" +}, +"smartCampaignError": { +"description": "The reasons for the Smart campaign error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_BUSINESS_LOCATION_ID", +"INVALID_CAMPAIGN", +"BUSINESS_NAME_OR_BUSINESS_LOCATION_ID_MISSING", +"REQUIRED_SUGGESTION_FIELD_MISSING", +"GEO_TARGETS_REQUIRED", +"CANNOT_DETERMINE_SUGGESTION_LOCALE", +"FINAL_URL_NOT_CRAWLABLE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The business location id is invalid.", +"The SmartCampaignSetting resource is only applicable for campaigns with advertising channel type SMART.", +"The business name or business location id is required.", +"A Smart campaign suggestion request field is required.", +"A location list or proximity is required.", +"The locale could not be determined.", +"The final URL could not be crawled." +], +"type": "string" +}, +"stringFormatError": { +"description": "The reasons for the string format error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"ILLEGAL_CHARS", +"INVALID_FORMAT" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The input string value contains disallowed characters.", +"The input string value is invalid for the associated field." +], +"type": "string" +}, +"stringLengthError": { +"description": "The reasons for the string length error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"EMPTY", +"TOO_SHORT", +"TOO_LONG" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The specified field should have a least one non-whitespace character in it.", +"Too short.", +"Too long." +], +"type": "string" +}, +"thirdPartyAppAnalyticsLinkError": { +"description": "The reasons for the third party app analytics link mutate error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_ANALYTICS_PROVIDER_ID", +"INVALID_MOBILE_APP_ID", +"MOBILE_APP_IS_NOT_ENABLED", +"CANNOT_REGENERATE_SHAREABLE_LINK_ID_FOR_REMOVED_LINK" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The provided analytics provider ID is invalid.", +"The provided mobile app ID is invalid.", +"The mobile app corresponding to the provided app ID is not active/enabled.", +"Regenerating shareable link ID is only allowed on active links" +], +"type": "string" +}, +"timeZoneError": { +"description": "The reasons for the time zone error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_TIME_ZONE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Time zone is not valid." +], +"type": "string" +}, +"urlFieldError": { +"description": "An error with a URL field mutate.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"INVALID_TRACKING_URL_TEMPLATE", +"INVALID_TAG_IN_TRACKING_URL_TEMPLATE", +"MISSING_TRACKING_URL_TEMPLATE_TAG", +"MISSING_PROTOCOL_IN_TRACKING_URL_TEMPLATE", +"INVALID_PROTOCOL_IN_TRACKING_URL_TEMPLATE", +"MALFORMED_TRACKING_URL_TEMPLATE", +"MISSING_HOST_IN_TRACKING_URL_TEMPLATE", +"INVALID_TLD_IN_TRACKING_URL_TEMPLATE", +"REDUNDANT_NESTED_TRACKING_URL_TEMPLATE_TAG", +"INVALID_FINAL_URL", +"INVALID_TAG_IN_FINAL_URL", +"REDUNDANT_NESTED_FINAL_URL_TAG", +"MISSING_PROTOCOL_IN_FINAL_URL", +"INVALID_PROTOCOL_IN_FINAL_URL", +"MALFORMED_FINAL_URL", +"MISSING_HOST_IN_FINAL_URL", +"INVALID_TLD_IN_FINAL_URL", +"INVALID_FINAL_MOBILE_URL", +"INVALID_TAG_IN_FINAL_MOBILE_URL", +"REDUNDANT_NESTED_FINAL_MOBILE_URL_TAG", +"MISSING_PROTOCOL_IN_FINAL_MOBILE_URL", +"INVALID_PROTOCOL_IN_FINAL_MOBILE_URL", +"MALFORMED_FINAL_MOBILE_URL", +"MISSING_HOST_IN_FINAL_MOBILE_URL", +"INVALID_TLD_IN_FINAL_MOBILE_URL", +"INVALID_FINAL_APP_URL", +"INVALID_TAG_IN_FINAL_APP_URL", +"REDUNDANT_NESTED_FINAL_APP_URL_TAG", +"MULTIPLE_APP_URLS_FOR_OSTYPE", +"INVALID_OSTYPE", +"INVALID_PROTOCOL_FOR_APP_URL", +"INVALID_PACKAGE_ID_FOR_APP_URL", +"URL_CUSTOM_PARAMETERS_COUNT_EXCEEDS_LIMIT", +"INVALID_CHARACTERS_IN_URL_CUSTOM_PARAMETER_KEY", +"INVALID_CHARACTERS_IN_URL_CUSTOM_PARAMETER_VALUE", +"INVALID_TAG_IN_URL_CUSTOM_PARAMETER_VALUE", +"REDUNDANT_NESTED_URL_CUSTOM_PARAMETER_TAG", +"MISSING_PROTOCOL", +"INVALID_PROTOCOL", +"INVALID_URL", +"DESTINATION_URL_DEPRECATED", +"INVALID_TAG_IN_URL", +"MISSING_URL_TAG", +"DUPLICATE_URL_ID", +"INVALID_URL_ID", +"FINAL_URL_SUFFIX_MALFORMED", +"INVALID_TAG_IN_FINAL_URL_SUFFIX", +"INVALID_TOP_LEVEL_DOMAIN", +"MALFORMED_TOP_LEVEL_DOMAIN", +"MALFORMED_URL", +"MISSING_HOST", +"NULL_CUSTOM_PARAMETER_VALUE", +"VALUE_TRACK_PARAMETER_NOT_SUPPORTED", +"UNSUPPORTED_APP_STORE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"The tracking url template is invalid.", +"The tracking url template contains invalid tag.", +"The tracking url template must contain at least one tag (for example, {lpurl}), This applies only to tracking url template associated with website ads or product ads.", +"The tracking url template must start with a valid protocol (or lpurl tag).", +"The tracking url template starts with an invalid protocol.", +"The tracking url template contains illegal characters.", +"The tracking url template must contain a host name (or lpurl tag).", +"The tracking url template has an invalid or missing top level domain extension.", +"The tracking url template contains nested occurrences of the same conditional tag (for example, {ifmobile:{ifmobile:x}}).", +"The final url is invalid.", +"The final url contains invalid tag.", +"The final url contains nested occurrences of the same conditional tag (for example, {ifmobile:{ifmobile:x}}).", +"The final url must start with a valid protocol.", +"The final url starts with an invalid protocol.", +"The final url contains illegal characters.", +"The final url must contain a host name.", +"The tracking url template has an invalid or missing top level domain extension.", +"The final mobile url is invalid.", +"The final mobile url contains invalid tag.", +"The final mobile url contains nested occurrences of the same conditional tag (for example, {ifmobile:{ifmobile:x}}).", +"The final mobile url must start with a valid protocol.", +"The final mobile url starts with an invalid protocol.", +"The final mobile url contains illegal characters.", +"The final mobile url must contain a host name.", +"The tracking url template has an invalid or missing top level domain extension.", +"The final app url is invalid.", +"The final app url contains invalid tag.", +"The final app url contains nested occurrences of the same conditional tag (for example, {ifmobile:{ifmobile:x}}).", +"More than one app url found for the same OS type.", +"The OS type given for an app url is not valid.", +"The protocol given for an app url is not valid. (For example, \"android-app://\")", +"The package id (app id) given for an app url is not valid.", +"The number of url custom parameters for an resource exceeds the maximum limit allowed.", +"An invalid character appears in the parameter key.", +"An invalid character appears in the parameter value.", +"The url custom parameter value fails url tag validation.", +"The custom parameter contains nested occurrences of the same conditional tag (for example, {ifmobile:{ifmobile:x}}).", +"The protocol (http:// or https://) is missing.", +"Unsupported protocol in URL. Only http and https are supported.", +"The url is invalid.", +"Destination Url is deprecated.", +"The url contains invalid tag.", +"The url must contain at least one tag (for example, {lpurl}).", +"Duplicate url id.", +"Invalid url id.", +"The final url suffix cannot begin with '?' or '&' characters and must be a valid query string.", +"The final url suffix cannot contain {lpurl} related or {ignore} tags.", +"The top level domain is invalid, for example, not a public top level domain listed in publicsuffix.org.", +"Malformed top level domain in URL.", +"Malformed URL.", +"No host found in URL.", +"Custom parameter value cannot be null.", +"Track parameter is not supported.", +"The app store connected to the url is not supported." +], +"type": "string" +}, +"userDataError": { +"description": "The reasons for the user data error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"OPERATIONS_FOR_CUSTOMER_MATCH_NOT_ALLOWED", +"TOO_MANY_USER_IDENTIFIERS", +"USER_LIST_NOT_APPLICABLE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Customer is not allowed to perform operations related to Customer Match.", +"Maximum number of user identifiers allowed for each request is 100 and for each operation is 20.", +"Current user list is not applicable for the given customer." +], +"type": "string" +}, +"userListCustomerTypeError": { +"description": "The reasons for a user list customer type error.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CONFLICTING_CUSTOMER_TYPES", +"NO_ACCESS_TO_USER_LIST", +"USERLIST_NOT_ELIGIBLE", +"CONVERSION_TRACKING_NOT_ENABLED_OR_NOT_MCC_MANAGER_ACCOUNT", +"TOO_MANY_USER_LISTS_FOR_THE_CUSTOMER_TYPE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Cannot add the conflicting customer types to the same user list. Conflicting labels: 1. Purchasers - Converted Leads 2. Purchasers - Qualified Leads 3. Purchasers - Cart Abandoners 4. Qualified Leads - Converted Leads 5. Disengaged customers - Converted Leads 6. Disengaged customers - Qualified Leads 7. Disengaged customers - Cart Abandoners 8. Converted Leads - Loyalty Tier X Members (X = 1..7) 9. Qualified Leads - Loyalty Tier X Members (X = 1..7) 10. Loyalty Tier X Members - Loyalty Tier Y Members (X != Y)", +"The account does not have access to the user list.", +"The given user list is not eligible for applying customer types. The user list must belong to one of the following types: CRM_BASED, RULE_BASED, ADVERTISER_DATA_MODEL_BASED, GCN.", +"To edit the user list customer type, conversion tracking must be enabled in your account. If cross-tracking is enabled, your account must be a MCC manager account to modify user list customer types. More info at https://support.google.com/google-ads/answer/3030657", +"Too many user lists for the customer type." +], +"type": "string" +}, +"userListError": { +"description": "The reasons for the user list error", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"EXTERNAL_REMARKETING_USER_LIST_MUTATE_NOT_SUPPORTED", +"CONCRETE_TYPE_REQUIRED", +"CONVERSION_TYPE_ID_REQUIRED", +"DUPLICATE_CONVERSION_TYPES", +"INVALID_CONVERSION_TYPE", +"INVALID_DESCRIPTION", +"INVALID_NAME", +"INVALID_TYPE", +"CAN_NOT_ADD_LOGICAL_LIST_AS_LOGICAL_LIST_OPERAND", +"INVALID_USER_LIST_LOGICAL_RULE_OPERAND", +"NAME_ALREADY_USED", +"NEW_CONVERSION_TYPE_NAME_REQUIRED", +"CONVERSION_TYPE_NAME_ALREADY_USED", +"OWNERSHIP_REQUIRED_FOR_SET", +"USER_LIST_MUTATE_NOT_SUPPORTED", +"INVALID_RULE", +"INVALID_DATE_RANGE", +"CAN_NOT_MUTATE_SENSITIVE_USERLIST", +"MAX_NUM_RULEBASED_USERLISTS", +"CANNOT_MODIFY_BILLABLE_RECORD_COUNT", +"APP_ID_NOT_SET", +"USERLIST_NAME_IS_RESERVED_FOR_SYSTEM_LIST", +"ADVERTISER_NOT_ON_ALLOWLIST_FOR_USING_UPLOADED_DATA", +"RULE_TYPE_IS_NOT_SUPPORTED", +"CAN_NOT_ADD_A_SIMILAR_USERLIST_AS_LOGICAL_LIST_OPERAND", +"CAN_NOT_MIX_CRM_BASED_IN_LOGICAL_LIST_WITH_OTHER_LISTS", +"APP_ID_NOT_ALLOWED", +"CANNOT_MUTATE_SYSTEM_LIST", +"MOBILE_APP_IS_SENSITIVE", +"SEED_LIST_DOES_NOT_EXIST", +"INVALID_SEED_LIST_ACCESS_REASON", +"INVALID_SEED_LIST_TYPE", +"INVALID_COUNTRY_CODES", +"PARTNER_AUDIENCE_SOURCE_NOT_SUPPORTED_FOR_USER_LIST_TYPE", +"COMMERCE_PARTNER_NOT_ALLOWED", +"PARTNER_AUDIENCE_INFO_NOT_SUPPORTED_FOR_USER_LIST_TYPE", +"PARTNER_MANAGER_ACCOUNT_DISALLOWED", +"PARTNER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA", +"ADVERTISER_TOS_NOT_ACCEPTED", +"ADVERTISER_PARTNER_LINK_MISSING", +"ADVERTISER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA", +"ACCOUNT_SETTING_TYPE_NOT_ALLOWED" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Creating and updating external remarketing user lists is not supported.", +"Concrete type of user list is required.", +"Creating/updating user list conversion types requires specifying the conversion type Id.", +"Remarketing user list cannot have duplicate conversion types.", +"Conversion type is invalid/unknown.", +"User list description is empty or invalid.", +"User list name is empty or invalid.", +"Type of the UserList does not match.", +"Embedded logical user lists are not allowed.", +"User list rule operand is invalid.", +"Name is already being used for another user list for the account.", +"Name is required when creating a new conversion type.", +"The given conversion type name has been used.", +"Only an owner account may edit a user list.", +"Creating user list without setting type in oneof user_list field, or creating/updating read-only user list types is not allowed.", +"Rule is invalid.", +"The specified date range is empty.", +"A UserList which is privacy sensitive or legal rejected cannot be mutated by external users.", +"Maximum number of rulebased user lists a customer can have.", +"BasicUserList's billable record field cannot be modified once it is set.", +"crm_based_user_list.app_id field must be set when upload_key_type is MOBILE_ADVERTISING_ID.", +"Name of the user list is reserved for system generated lists and cannot be used.", +"Advertiser needs to be on the allow-list to use remarketing lists created from advertiser uploaded data (for example, Customer Match lists).", +"The provided rule_type is not supported for the user list.", +"Similar user list cannot be used as a logical user list operand.", +"Logical user list should not have a mix of CRM based user list and other types of lists in its rules.", +"crm_based_user_list.app_id field can only be set when upload_key_type is MOBILE_ADVERTISING_ID.", +"Google system generated user lists cannot be mutated.", +"The mobile app associated with the remarketing list is sensitive.", +"One or more given seed lists do not exist.", +"One or more given seed lists are not accessible to the current user.", +"One or more given seed lists have an unsupported type.", +"One or more invalid country codes are added to Lookalike UserList.", +"The partner audience source is not supported for the user list type.", +"The commerce partner is only supported for COMMERCE_AUDIENCE.", +"The partner audience info is not supported for the user list type.", +"Manager account is not allowed to create this UserList.", +"This UserList can only be created by allowlisted partners.", +"The advertiser must accept the Terms of Service to create this UserList.", +"The advertiser must have an active link to the partner to create this UserList.", +"This UserList can only be created for allowlisted advertisers.", +"This UserList is not allowed for this account type." +], +"type": "string" +}, +"videoCampaignError": { +"description": "An error with a Video Campaign mutate.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"MUTATE_REQUIRES_RESERVATION" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Cannot modify the video campaign without reservation. See https://support.google.com/google-ads/answer/9547606." +], +"type": "string" +}, +"youtubeVideoRegistrationError": { +"description": "The reasons for YouTube video registration errors.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"VIDEO_NOT_FOUND", +"VIDEO_NOT_ACCESSIBLE", +"VIDEO_NOT_ELIGIBLE" +], +"enumDescriptions": [ +"Enum unspecified.", +"The received error code is not known in this version.", +"Video to be registered wasn't found.", +"Video to be registered is not accessible (for example, private).", +"Video to be registered is not eligible (for example, mature content)." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Errors__ErrorDetails": { +"description": "Additional error details.", +"id": "GoogleAdsSearchads360V23Errors__ErrorDetails", +"properties": { +"budgetPerDayMinimumErrorDetails": { +"$ref": "GoogleAdsSearchads360V23Errors__BudgetPerDayMinimumErrorDetails", +"description": "Details for a budget below per-day minimum error." +}, +"policyFindingDetails": { +"$ref": "GoogleAdsSearchads360V23Errors__PolicyFindingDetails", +"description": "Describes policy violation findings." +}, +"policyViolationDetails": { +"$ref": "GoogleAdsSearchads360V23Errors__PolicyViolationDetails", +"description": "Describes an ad policy violation." +}, +"quotaErrorDetails": { +"$ref": "GoogleAdsSearchads360V23Errors__QuotaErrorDetails", +"description": "Details on the quota error, including the scope (account or developer), the rate bucket name and the retry delay." +}, +"resourceCountDetails": { +"$ref": "GoogleAdsSearchads360V23Errors__ResourceCountDetails", +"description": "Details for a resource count limit exceeded error." +}, +"unpublishedErrorCode": { +"description": "The error code that should have been returned, but wasn't. This is used when the error code is not published in the client specified version.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Errors__ErrorLocation": { +"description": "Describes the part of the request proto that caused the error.", +"id": "GoogleAdsSearchads360V23Errors__ErrorLocation", +"properties": { +"fieldPathElements": { +"description": "A field path that indicates which field was invalid in the request.", +"items": { +"$ref": "GoogleAdsSearchads360V23Errors_ErrorLocation_FieldPathElement" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Errors__PolicyFindingDetails": { +"description": "Error returned as part of a mutate response. This error indicates one or more policy findings in the fields of a resource.", +"id": "GoogleAdsSearchads360V23Errors__PolicyFindingDetails", +"properties": { +"policyTopicEntries": { +"description": "The list of policy topics for the resource. Contains the PROHIBITED or FULLY_LIMITED policy topic entries that prevented the resource from being saved (among any other entries the resource may also have).", +"items": { +"$ref": "GoogleAdsSearchads360V23Common__PolicyTopicEntry" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Errors__PolicyViolationDetails": { +"description": "Error returned as part of a mutate response. This error indicates single policy violation by some text in one of the fields.", +"id": "GoogleAdsSearchads360V23Errors__PolicyViolationDetails", +"properties": { +"externalPolicyDescription": { +"description": "Human readable description of policy violation.", +"type": "string" +}, +"externalPolicyName": { +"description": "Human readable name of the policy.", +"type": "string" +}, +"isExemptible": { +"description": "Whether user can file an exemption request for this violation.", +"type": "boolean" +}, +"key": { +"$ref": "GoogleAdsSearchads360V23Common__PolicyViolationKey", +"description": "Unique identifier for this violation. If policy is exemptible, this key may be used to request exemption." +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Errors__QuotaErrorDetails": { +"description": "Additional quota error details when there is QuotaError.", +"id": "GoogleAdsSearchads360V23Errors__QuotaErrorDetails", +"properties": { +"rateName": { +"description": "The high level description of the quota bucket. Examples are \"Get requests for standard access\" or \"Requests per account\".", +"type": "string" +}, +"rateScope": { +"description": "The rate scope of the quota limit.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"ACCOUNT", +"DEVELOPER" +], +"enumDescriptions": [ +"Unspecified enum", +"Used for return value only. Represents value unknown in this version.", +"Per customer account quota", +"Per project quota" +], +"type": "string" +}, +"retryDelay": { +"description": "Backoff period that customers should wait before sending next request.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Errors__ResourceCountDetails": { +"description": "Error details returned when an resource count limit was exceeded.", +"id": "GoogleAdsSearchads360V23Errors__ResourceCountDetails", +"properties": { +"enclosingId": { +"description": "The ID of the resource whose limit was exceeded. External customer ID if the limit is for a customer.", +"type": "string" +}, +"enclosingResource": { +"description": "The name of the resource ( etc.) whose limit was exceeded.", +"type": "string" +}, +"existingCount": { +"description": "The count of existing entities.", +"format": "int32", +"type": "integer" +}, +"limit": { +"description": "The limit which was exceeded.", +"format": "int32", +"type": "integer" +}, +"limitType": { +"description": "The resource limit type which was exceeded.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"CAMPAIGNS_PER_CUSTOMER", +"BASE_CAMPAIGNS_PER_CUSTOMER", +"EXPERIMENT_CAMPAIGNS_PER_CUSTOMER", +"HOTEL_CAMPAIGNS_PER_CUSTOMER", +"SMART_SHOPPING_CAMPAIGNS_PER_CUSTOMER", +"AD_GROUPS_PER_CAMPAIGN", +"AD_GROUPS_PER_SHOPPING_CAMPAIGN", +"AD_GROUPS_PER_HOTEL_CAMPAIGN", +"REPORTING_AD_GROUPS_PER_LOCAL_CAMPAIGN", +"REPORTING_AD_GROUPS_PER_APP_CAMPAIGN", +"MANAGED_AD_GROUPS_PER_SMART_CAMPAIGN", +"AD_GROUP_CRITERIA_PER_CUSTOMER", +"BASE_AD_GROUP_CRITERIA_PER_CUSTOMER", +"EXPERIMENT_AD_GROUP_CRITERIA_PER_CUSTOMER", +"AD_GROUP_CRITERIA_PER_CAMPAIGN", +"CAMPAIGN_CRITERIA_PER_CUSTOMER", +"BASE_CAMPAIGN_CRITERIA_PER_CUSTOMER", +"EXPERIMENT_CAMPAIGN_CRITERIA_PER_CUSTOMER", +"WEBPAGE_CRITERIA_PER_CUSTOMER", +"BASE_WEBPAGE_CRITERIA_PER_CUSTOMER", +"EXPERIMENT_WEBPAGE_CRITERIA_PER_CUSTOMER", +"COMBINED_AUDIENCE_CRITERIA_PER_AD_GROUP", +"CUSTOMER_NEGATIVE_PLACEMENT_CRITERIA_PER_CUSTOMER", +"CUSTOMER_NEGATIVE_YOUTUBE_CHANNEL_CRITERIA_PER_CUSTOMER", +"CRITERIA_PER_AD_GROUP", +"LISTING_GROUPS_PER_AD_GROUP", +"EXPLICITLY_SHARED_BUDGETS_PER_CUSTOMER", +"IMPLICITLY_SHARED_BUDGETS_PER_CUSTOMER", +"COMBINED_AUDIENCE_CRITERIA_PER_CAMPAIGN", +"NEGATIVE_KEYWORDS_PER_CAMPAIGN", +"NEGATIVE_PLACEMENTS_PER_CAMPAIGN", +"GEO_TARGETS_PER_CAMPAIGN", +"NEGATIVE_IP_BLOCKS_PER_CAMPAIGN", +"PROXIMITIES_PER_CAMPAIGN", +"LISTING_SCOPES_PER_SHOPPING_CAMPAIGN", +"LISTING_SCOPES_PER_NON_SHOPPING_CAMPAIGN", +"NEGATIVE_KEYWORDS_PER_SHARED_SET", +"NEGATIVE_PLACEMENTS_PER_SHARED_SET", +"SHARED_SETS_PER_CUSTOMER_FOR_TYPE_DEFAULT", +"SHARED_SETS_PER_CUSTOMER_FOR_NEGATIVE_PLACEMENT_LIST_LOWER", +"HOTEL_ADVANCE_BOOKING_WINDOW_BID_MODIFIERS_PER_AD_GROUP", +"BIDDING_STRATEGIES_PER_CUSTOMER", +"BASIC_USER_LISTS_PER_CUSTOMER", +"LOGICAL_USER_LISTS_PER_CUSTOMER", +"RULE_BASED_USER_LISTS_PER_CUSTOMER", +"BASE_AD_GROUP_ADS_PER_CUSTOMER", +"EXPERIMENT_AD_GROUP_ADS_PER_CUSTOMER", +"AD_GROUP_ADS_PER_CAMPAIGN", +"TEXT_AND_OTHER_ADS_PER_AD_GROUP", +"IMAGE_ADS_PER_AD_GROUP", +"SHOPPING_SMART_ADS_PER_AD_GROUP", +"RESPONSIVE_SEARCH_ADS_PER_AD_GROUP", +"APP_ADS_PER_AD_GROUP", +"APP_ENGAGEMENT_ADS_PER_AD_GROUP", +"LOCAL_ADS_PER_AD_GROUP", +"VIDEO_ADS_PER_AD_GROUP", +"LEAD_FORM_CAMPAIGN_ASSETS_PER_CAMPAIGN", +"PROMOTION_CUSTOMER_ASSETS_PER_CUSTOMER", +"PROMOTION_CAMPAIGN_ASSETS_PER_CAMPAIGN", +"PROMOTION_AD_GROUP_ASSETS_PER_AD_GROUP", +"CALLOUT_CUSTOMER_ASSETS_PER_CUSTOMER", +"CALLOUT_CAMPAIGN_ASSETS_PER_CAMPAIGN", +"CALLOUT_AD_GROUP_ASSETS_PER_AD_GROUP", +"SITELINK_CUSTOMER_ASSETS_PER_CUSTOMER", +"SITELINK_CAMPAIGN_ASSETS_PER_CAMPAIGN", +"SITELINK_AD_GROUP_ASSETS_PER_AD_GROUP", +"STRUCTURED_SNIPPET_CUSTOMER_ASSETS_PER_CUSTOMER", +"STRUCTURED_SNIPPET_CAMPAIGN_ASSETS_PER_CAMPAIGN", +"STRUCTURED_SNIPPET_AD_GROUP_ASSETS_PER_AD_GROUP", +"MOBILE_APP_CUSTOMER_ASSETS_PER_CUSTOMER", +"MOBILE_APP_CAMPAIGN_ASSETS_PER_CAMPAIGN", +"MOBILE_APP_AD_GROUP_ASSETS_PER_AD_GROUP", +"HOTEL_CALLOUT_CUSTOMER_ASSETS_PER_CUSTOMER", +"HOTEL_CALLOUT_CAMPAIGN_ASSETS_PER_CAMPAIGN", +"HOTEL_CALLOUT_AD_GROUP_ASSETS_PER_AD_GROUP", +"CALL_CUSTOMER_ASSETS_PER_CUSTOMER", +"CALL_CAMPAIGN_ASSETS_PER_CAMPAIGN", +"CALL_AD_GROUP_ASSETS_PER_AD_GROUP", +"PRICE_CUSTOMER_ASSETS_PER_CUSTOMER", +"PRICE_CAMPAIGN_ASSETS_PER_CAMPAIGN", +"PRICE_AD_GROUP_ASSETS_PER_AD_GROUP", +"AD_IMAGE_CAMPAIGN_ASSETS_PER_CAMPAIGN", +"AD_IMAGE_AD_GROUP_ASSETS_PER_AD_GROUP", +"PAGE_FEED_ASSET_SETS_PER_CUSTOMER", +"DYNAMIC_EDUCATION_FEED_ASSET_SETS_PER_CUSTOMER", +"ASSETS_PER_PAGE_FEED_ASSET_SET", +"ASSETS_PER_DYNAMIC_EDUCATION_FEED_ASSET_SET", +"DYNAMIC_REAL_ESTATE_ASSET_SETS_PER_CUSTOMER", +"ASSETS_PER_DYNAMIC_REAL_ESTATE_ASSET_SET", +"DYNAMIC_CUSTOM_ASSET_SETS_PER_CUSTOMER", +"ASSETS_PER_DYNAMIC_CUSTOM_ASSET_SET", +"DYNAMIC_HOTELS_AND_RENTALS_ASSET_SETS_PER_CUSTOMER", +"ASSETS_PER_DYNAMIC_HOTELS_AND_RENTALS_ASSET_SET", +"DYNAMIC_LOCAL_ASSET_SETS_PER_CUSTOMER", +"ASSETS_PER_DYNAMIC_LOCAL_ASSET_SET", +"DYNAMIC_FLIGHTS_ASSET_SETS_PER_CUSTOMER", +"ASSETS_PER_DYNAMIC_FLIGHTS_ASSET_SET", +"DYNAMIC_TRAVEL_ASSET_SETS_PER_CUSTOMER", +"ASSETS_PER_DYNAMIC_TRAVEL_ASSET_SET", +"DYNAMIC_JOBS_ASSET_SETS_PER_CUSTOMER", +"ASSETS_PER_DYNAMIC_JOBS_ASSET_SET", +"BUSINESS_NAME_CAMPAIGN_ASSETS_PER_CAMPAIGN", +"BUSINESS_LOGO_CAMPAIGN_ASSETS_PER_CAMPAIGN", +"VERSIONS_PER_AD", +"USER_FEEDS_PER_CUSTOMER", +"SYSTEM_FEEDS_PER_CUSTOMER", +"FEED_ATTRIBUTES_PER_FEED", +"FEED_ITEMS_PER_CUSTOMER", +"CAMPAIGN_FEEDS_PER_CUSTOMER", +"BASE_CAMPAIGN_FEEDS_PER_CUSTOMER", +"EXPERIMENT_CAMPAIGN_FEEDS_PER_CUSTOMER", +"AD_GROUP_FEEDS_PER_CUSTOMER", +"BASE_AD_GROUP_FEEDS_PER_CUSTOMER", +"EXPERIMENT_AD_GROUP_FEEDS_PER_CUSTOMER", +"AD_GROUP_FEEDS_PER_CAMPAIGN", +"FEED_ITEM_SETS_PER_CUSTOMER", +"FEED_ITEMS_PER_FEED_ITEM_SET", +"CAMPAIGN_EXPERIMENTS_PER_CUSTOMER", +"EXPERIMENT_ARMS_PER_VIDEO_EXPERIMENT", +"OWNED_LABELS_PER_CUSTOMER", +"LABELS_PER_CAMPAIGN", +"LABELS_PER_AD_GROUP", +"LABELS_PER_AD_GROUP_AD", +"LABELS_PER_AD_GROUP_CRITERION", +"TARGET_CUSTOMERS_PER_LABEL", +"KEYWORD_PLANS_PER_USER_PER_CUSTOMER", +"KEYWORD_PLAN_AD_GROUP_KEYWORDS_PER_KEYWORD_PLAN", +"KEYWORD_PLAN_AD_GROUPS_PER_KEYWORD_PLAN", +"KEYWORD_PLAN_NEGATIVE_KEYWORDS_PER_KEYWORD_PLAN", +"KEYWORD_PLAN_CAMPAIGNS_PER_KEYWORD_PLAN", +"CONVERSION_ACTIONS_PER_CUSTOMER", +"BATCH_JOB_OPERATIONS_PER_JOB", +"BATCH_JOBS_PER_CUSTOMER", +"HOTEL_CHECK_IN_DATE_RANGE_BID_MODIFIERS_PER_AD_GROUP", +"SHARED_SETS_PER_ACCOUNT_FOR_ACCOUNT_LEVEL_NEGATIVE_KEYWORDS", +"ACCOUNT_LEVEL_NEGATIVE_KEYWORDS_PER_SHARED_SET", +"ENABLED_ASSET_PER_HOTEL_PROPERTY_ASSET_SET", +"ENABLED_HOTEL_PROPERTY_ASSET_LINKS_PER_ASSET_GROUP", +"BRANDS_PER_SHARED_SET", +"ENABLED_BRAND_LIST_CRITERIA_PER_CAMPAIGN", +"SHARED_SETS_PER_ACCOUNT_FOR_BRAND", +"LOOKALIKE_USER_LISTS_PER_CUSTOMER", +"LOGO_CAMPAIGN_ASSETS_PER_CAMPAIGN", +"BUSINESS_MESSAGE_ASSET_LINKS_PER_CUSTOMER", +"WHATSAPP_BUSINESS_MESSAGE_ASSET_LINKS_PER_CAMPAIGN", +"WHATSAPP_BUSINESS_MESSAGE_ASSET_LINKS_PER_AD_GROUP", +"BRAND_LIST_CRITERIA_PER_AD_GROUP" +], +"enumDescriptions": [ +"No value has been specified.", +"Used for return value only. Represents an unclassified operation unknown in this version.", +"Number of ENABLED and PAUSED campaigns per customer.", +"Number of ENABLED and PAUSED base campaigns per customer.", +"Number of ENABLED and PAUSED experiment campaigns per customer.", +"Number of ENABLED and PAUSED Hotel campaigns per customer.", +"Number of ENABLED and PAUSED Smart Shopping campaigns per customer.", +"Number of ENABLED ad groups per campaign.", +"Number of ENABLED ad groups per Shopping campaign.", +"Number of ENABLED ad groups per Hotel campaign.", +"Number of ENABLED reporting ad groups per local campaign.", +"Number of ENABLED reporting ad groups per App campaign. It includes app campaign and app campaign for engagement.", +"Number of ENABLED managed ad groups per smart campaign.", +"Number of ENABLED ad group criteria per customer. An ad group criterion is considered as ENABLED if: 1. it's not REMOVED 2. its ad group is not REMOVED 3. its campaign is not REMOVED.", +"Number of ad group criteria across all base campaigns for a customer.", +"Number of ad group criteria across all experiment campaigns for a customer.", +"Number of ENABLED ad group criteria per campaign. An ad group criterion is considered as ENABLED if: 1. it's not REMOVED 2. its ad group is not REMOVED.", +"Number of ENABLED campaign criteria per customer.", +"Number of ENABLED campaign criteria across all base campaigns for a customer.", +"Number of ENABLED campaign criteria across all experiment campaigns for a customer.", +"Number of ENABLED webpage criteria per customer, including campaign level and ad group level.", +"Number of ENABLED webpage criteria across all base campaigns for a customer.", +"Meximum number of ENABLED webpage criteria across all experiment campaigns for a customer.", +"Number of combined audience criteria per ad group.", +"Limit for placement criterion type group in customer negative criterion.", +"Limit for YouTube TV channels in customer negative criterion.", +"Number of ENABLED criteria per ad group.", +"Number of listing group criteria per ad group.", +"Number of ENABLED explicitly shared budgets per customer.", +"Number of ENABLED implicitly shared budgets per customer.", +"Number of combined audience criteria per campaign.", +"Number of negative keywords per campaign.", +"Number of excluded campaign criteria in placement dimension, for example, placement, mobile application, YouTube channel, etc. The API criterion type is NOT limited to placement only, and this does not include exclusions at the ad group or other levels.", +"Number of geo targets per campaign.", +"Number of negative IP blocks per campaign.", +"Number of proximity targets per campaign.", +"Number of listing scopes per Shopping campaign.", +"Number of listing scopes per non-Shopping campaign.", +"Number of criteria per negative keyword shared set.", +"Number of criteria per negative placement shared set.", +"Default number of shared sets allowed per type per customer.", +"Number of shared sets of negative placement list type for a manager customer.", +"Number of hotel_advance_booking_window bid modifiers per ad group.", +"Number of ENABLED shared bidding strategies per customer.", +"Number of open basic user lists per customer.", +"Number of open logical user lists per customer.", +"Number of open rule based user lists per customer.", +"Number of ENABLED and PAUSED ad group ads across all base campaigns for a customer.", +"Number of ENABLED and PAUSED ad group ads across all experiment campaigns for a customer.", +"Number of ENABLED and PAUSED ad group ads per campaign.", +"Number of ENABLED ads per ad group that do not fall in to other buckets. Includes text and many other types.", +"Number of ENABLED image ads per ad group.", +"Number of ENABLED shopping smart ads per ad group.", +"Number of ENABLED responsive search ads per ad group.", +"Number of ENABLED app ads per ad group.", +"Number of ENABLED app engagement ads per ad group.", +"Number of ENABLED local ads per ad group.", +"Number of ENABLED video ads per ad group.", +"Number of ENABLED lead form CampaignAssets per campaign.", +"Number of ENABLED promotion CustomerAssets per customer.", +"Number of ENABLED promotion CampaignAssets per campaign.", +"Number of ENABLED promotion AdGroupAssets per ad group.", +"Number of ENABLED callout CustomerAssets per customer.", +"Number of ENABLED callout CampaignAssets per campaign.", +"Number of ENABLED callout AdGroupAssets per ad group.", +"Number of ENABLED sitelink CustomerAssets per customer.", +"Number of ENABLED sitelink CampaignAssets per campaign.", +"Number of ENABLED sitelink AdGroupAssets per ad group.", +"Number of ENABLED structured snippet CustomerAssets per customer.", +"Number of ENABLED structured snippet CampaignAssets per campaign.", +"Number of ENABLED structured snippet AdGroupAssets per ad group.", +"Number of ENABLED mobile app CustomerAssets per customer.", +"Number of ENABLED mobile app CampaignAssets per campaign.", +"Number of ENABLED mobile app AdGroupAssets per ad group.", +"Number of ENABLED hotel callout CustomerAssets per customer.", +"Number of ENABLED hotel callout CampaignAssets per campaign.", +"Number of ENABLED hotel callout AdGroupAssets per ad group.", +"Number of ENABLED call CustomerAssets per customer.", +"Number of ENABLED call CampaignAssets per campaign.", +"Number of ENABLED call AdGroupAssets per ad group.", +"Number of ENABLED price CustomerAssets per customer.", +"Number of ENABLED price CampaignAssets per campaign.", +"Number of ENABLED price AdGroupAssets per ad group.", +"Number of ENABLED ad image CampaignAssets per campaign.", +"Number of ENABLED ad image AdGroupAssets per ad group.", +"Number of ENABLED page feed asset sets per customer.", +"Number of ENABLED dynamic education feed asset sets per customer.", +"Number of ENABLED assets per page feed asset set.", +"Number of ENABLED assets per dynamic education asset set.", +"Number of ENABLED dynamic real estate asset sets per customer.", +"Number of ENABLED assets per dynamic real estate asset set.", +"Number of ENABLED dynamic custom asset sets per customer.", +"Number of ENABLED assets per dynamic custom asset set.", +"Number of ENABLED dynamic hotels and rentals asset sets per customer.", +"Number of ENABLED assets per dynamic hotels and rentals asset set.", +"Number of ENABLED dynamic local asset sets per customer.", +"Number of ENABLED assets per dynamic local asset set.", +"Number of ENABLED dynamic flights asset sets per customer.", +"Number of ENABLED assets per dynamic flights asset set.", +"Number of ENABLED dynamic travel asset sets per customer.", +"Number of ENABLED assets per dynamic travel asset set.", +"Number of ENABLED dynamic jobs asset sets per customer.", +"Number of ENABLED assets per dynamic jobs asset set.", +"Number of ENABLED business name CampaignAssets per campaign.", +"Number of ENABLED business logo CampaignAssets per campaign.", +"Number of versions per ad.", +"Number of ENABLED user feeds per customer.", +"Number of ENABLED system feeds per customer.", +"Number of feed attributes per feed.", +"Number of ENABLED feed items per customer.", +"Number of ENABLED campaign feeds per customer.", +"Number of ENABLED campaign feeds across all base campaigns for a customer.", +"Number of ENABLED campaign feeds across all experiment campaigns for a customer.", +"Number of ENABLED ad group feeds per customer.", +"Number of ENABLED ad group feeds across all base campaigns for a customer.", +"Number of ENABLED ad group feeds across all experiment campaigns for a customer.", +"Number of ENABLED ad group feeds per campaign.", +"Number of ENABLED feed items per customer.", +"Number of feed items per feed item set.", +"Number of ENABLED campaign experiments per customer.", +"Number of video experiment arms per experiment.", +"Number of owned labels per customer.", +"Number of applied labels per campaign.", +"Number of applied labels per ad group.", +"Number of applied labels per ad group ad.", +"Number of applied labels per ad group criterion.", +"Number of customers with a single label applied.", +"Number of ENABLED keyword plans per user per customer. The limit is applied per pair because by default a plan is private to a user of a customer. Each user of a customer has their own independent limit.", +"Number of keyword plan ad group keywords per keyword plan.", +"Number of keyword plan ad groups per keyword plan.", +"Number of keyword plan negative keywords (both campaign and ad group) per keyword plan.", +"Number of keyword plan campaigns per keyword plan.", +"Number of ENABLED conversion actions per customer.", +"Number of operations in a single batch job.", +"Number of PENDING or ENABLED batch jobs per customer.", +"Number of hotel check-in date range bid modifiers per ad agroup.", +"Number of shared sets of type ACCOUNT_LEVEL_NEGATIVE_KEYWORDS per account.", +"Number of keywords per ACCOUNT_LEVEL_NEGATIVE_KEYWORDS shared set.", +"Maximum number of asset per hotel property asset set.", +"Maximum number of enabled hotel property assets per asset group.", +"Number of criteria per brand shared set.", +"Number of active brand list criteria per campaign.", +"Maximum number of shared sets of brand type for an account.", +"Maximum number of lookalike lists per customer.", +"Total number of enabled IMAGE CampaignAssets with LOGO and LANDSCAPE_LOGO field types per campaign.", +"Maximum number of active business message asset links at customer level.", +"Maximum number of active WhatsApp business message asset links at campaign level.", +"Maximum number of active WhatsApp business message asset links at ad group level.", +"Number of ENABLED brand list criteria per ad group." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Errors__SearchAds360Error": { +"description": "Search Ads 360-specific error.", +"id": "GoogleAdsSearchads360V23Errors__SearchAds360Error", +"properties": { +"details": { +"$ref": "GoogleAdsSearchads360V23Errors__ErrorDetails", +"description": "Additional error details, which are returned by certain error codes. Most error codes do not include details." +}, +"errorCode": { +"$ref": "GoogleAdsSearchads360V23Errors__ErrorCode", +"description": "An enum value that indicates which error occurred." +}, +"location": { +"$ref": "GoogleAdsSearchads360V23Errors__ErrorLocation", +"description": "Describes the part of the request proto that caused the error." +}, +"message": { +"description": "A human-readable description of the error.", +"type": "string" +}, +"trigger": { +"$ref": "GoogleAdsSearchads360V23Common__Value", +"description": "The value that triggered the error." +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Errors__SearchAds360Failure": { +"description": "Describes how a Search Ads 360 API call failed. It's returned inside google.rpc.Status.details when a call fails.", +"id": "GoogleAdsSearchads360V23Errors__SearchAds360Failure", +"properties": { +"errors": { +"description": "The list of errors that occurred.", +"items": { +"$ref": "GoogleAdsSearchads360V23Errors__SearchAds360Error" +}, +"type": "array" +}, +"requestId": { +"description": "The unique ID of the request that is used for debugging purposes.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Resources_BatchJob_BatchJobMetadata": { +"description": "Additional information about the batch job. This message is also used as metadata returned in batch job Long Running Operations.", +"id": "GoogleAdsSearchads360V23Resources_BatchJob_BatchJobMetadata", +"properties": { +"completionDateTime": { +"description": "Output only. The time when this batch job was completed. Formatted as yyyy-MM-dd HH:mm:ss. Example: \"2018-03-05 09:16:00\"", +"readOnly": true, +"type": "string" +}, +"creationDateTime": { +"description": "Output only. The time when this batch job was created. Formatted as yyyy-mm-dd hh:mm:ss. Example: \"2018-03-05 09:15:00\"", +"readOnly": true, +"type": "string" +}, +"estimatedCompletionRatio": { +"description": "Output only. The fraction (between 0.0 and 1.0) of mutates that have been processed. This is empty if the job hasn't started running yet.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"executedOperationCount": { +"description": "Output only. The number of mutate operations executed by the batch job. Present only if the job has started running.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"executionLimitSeconds": { +"description": "Immutable. The approximate upper bound for how long a batch job can be executed, in seconds. If the job runs more than the given upper bound, the job will be canceled.", +"format": "int32", +"type": "integer" +}, +"operationCount": { +"description": "Output only. The number of mutate operations in the batch job.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"startDateTime": { +"description": "Output only. The time when this batch job started running. Formatted as yyyy-mm-dd hh:mm:ss. Example: \"2018-03-05 09:15:30\"", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Resources__OfflineUserDataJobMetadata": { +"description": "Metadata of offline user data job.", +"id": "GoogleAdsSearchads360V23Resources__OfflineUserDataJobMetadata", +"properties": { +"matchRateRange": { +"description": "Output only. Match rate of the Customer Match user list upload. Describes the estimated match rate when the status of the job is \"RUNNING\" and final match rate when the final match rate is available after the status of the job is \"SUCCESS/FAILED\".", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"MATCH_RANGE_LESS_THAN_20", +"MATCH_RANGE_20_TO_30", +"MATCH_RANGE_31_TO_40", +"MATCH_RANGE_41_TO_50", +"MATCH_RANGE_51_TO_60", +"MATCH_RANGE_61_TO_70", +"MATCH_RANGE_71_TO_80", +"MATCH_RANGE_81_TO_90", +"MATCH_RANGE_91_TO_100" +], +"enumDescriptions": [ +"Not specified.", +"Default value for match rate range.", +"Match rate range for offline data upload entity is between 0% and 19%.", +"Match rate range for offline data upload entity is between 20% and 30%.", +"Match rate range for offline data upload entity is between 31% and 40%.", +"Match rate range for offline data upload entity is between 41% and 50%.", +"Match rate range for offline data upload entity is between 51% and 60%.", +"Match rate range for offline data upload entity is between 61% and 70%.", +"Match rate range for offline data upload entity is between 71% and 80%.", +"Match rate range for offline data upload entity is between 81% and 90%.", +"Match rate range for offline data upload entity is more than or equal to 91%." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Services__PromoteExperimentMetadata": { +"description": "The metadata of the promoted experiment.", +"id": "GoogleAdsSearchads360V23Services__PromoteExperimentMetadata", +"properties": { +"experiment": { +"description": "Required. The promoted experiment.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Services__ScheduleExperimentMetadata": { +"description": "The metadata of the scheduled experiment.", +"id": "GoogleAdsSearchads360V23Services__ScheduleExperimentMetadata", +"properties": { +"experiment": { +"description": "Required. The scheduled experiment.", +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", From 38dc16fb5851ffd863ce455edf6503594d4db104 Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 21 Apr 2026 07:41:56 +0000 Subject: [PATCH 17/18] feat(secretmanager): update the api #### secretmanager:v1 The following keys were added: - schemas.OperationMetadata.properties.progress (Total Keys: 2) - schemas.Progress (Total Keys: 11) #### secretmanager:v1beta1 The following keys were added: - schemas.OperationMetadata.properties.progress (Total Keys: 2) - schemas.Progress (Total Keys: 11) --- .../secretmanager_v1.projects.locations.html | 4 +- ...retmanager_v1beta1.projects.locations.html | 4 +- .../documents/secretmanager.v1.json | 38 +++++++++++++++++-- .../documents/secretmanager.v1beta1.json | 38 +++++++++++++++++-- 4 files changed, 72 insertions(+), 12 deletions(-) diff --git a/docs/dyn/secretmanager_v1.projects.locations.html b/docs/dyn/secretmanager_v1.projects.locations.html index 1149585933..422b2670a1 100644 --- a/docs/dyn/secretmanager_v1.projects.locations.html +++ b/docs/dyn/secretmanager_v1.projects.locations.html @@ -87,7 +87,7 @@ Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -126,7 +126,7 @@Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/secretmanager_v1beta1.projects.locations.html b/docs/dyn/secretmanager_v1beta1.projects.locations.html index 178c0231eb..5177f2aeb1 100644 --- a/docs/dyn/secretmanager_v1beta1.projects.locations.html +++ b/docs/dyn/secretmanager_v1beta1.projects.locations.html @@ -82,7 +82,7 @@Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -121,7 +121,7 @@Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1.json index e561e1412a..6ae53ef7c7 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1.json @@ -387,7 +387,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "secretmanager.projects.locations.list", @@ -1366,7 +1366,7 @@ } } }, -"revision": "20260213", +"revision": "20260327", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { @@ -1715,17 +1715,22 @@ "type": "string" }, "createTime": { -"description": "Output only. The time the operation was created.", +"description": "Output only. Time the operation was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "endTime": { -"description": "Output only. The time the operation finished running.", +"description": "Output only. Time the operation finished running.", "format": "google-datetime", "readOnly": true, "type": "string" }, +"progress": { +"$ref": "Progress", +"description": "Output only. Represents the progress of the operation. This field is populated for operations that involve processing multiple secret versions.", +"readOnly": true +}, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "readOnly": true, @@ -1780,6 +1785,31 @@ }, "type": "object" }, +"Progress": { +"description": "Represents progress information for operations involving multiple secret versions.", +"id": "Progress", +"properties": { +"completedVersionCount": { +"description": "Output only. Number of secret versions that have been successfully processed so far.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"failedVersionCount": { +"description": "Output only. Number of secret versions that failed to process.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"totalVersionCount": { +"description": "Output only. Provides the total number of secret versions to be processed by the operation.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "Replica": { "description": "Represents a Replica for this Secret.", "id": "Replica", diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json index 79844b7cf4..6a940eb035 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json @@ -387,7 +387,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "secretmanager.projects.locations.list", @@ -886,7 +886,7 @@ } } }, -"revision": "20260213", +"revision": "20260327", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { @@ -1181,17 +1181,22 @@ "type": "string" }, "createTime": { -"description": "Output only. The time the operation was created.", +"description": "Output only. Time the operation was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "endTime": { -"description": "Output only. The time the operation finished running.", +"description": "Output only. Time the operation finished running.", "format": "google-datetime", "readOnly": true, "type": "string" }, +"progress": { +"$ref": "Progress", +"description": "Output only. Represents the progress of the operation. This field is populated for operations that involve processing multiple secret versions.", +"readOnly": true +}, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "readOnly": true, @@ -1246,6 +1251,31 @@ }, "type": "object" }, +"Progress": { +"description": "Represents progress information for operations involving multiple secret versions.", +"id": "Progress", +"properties": { +"completedVersionCount": { +"description": "Output only. Number of secret versions that have been successfully processed so far.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"failedVersionCount": { +"description": "Output only. Number of secret versions that failed to process.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"totalVersionCount": { +"description": "Output only. Provides the total number of secret versions to be processed by the operation.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "Replica": { "description": "Represents a Replica for this Secret.", "id": "Replica", From 7c5fc6a5147b17ecca2ce5b7c04b1bc9fa768392 Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 21 Apr 2026 07:41:56 +0000 Subject: [PATCH 18/18] chore(docs): Add new discovery artifacts and artifacts with minor updates --- ....monetization.subscriptions.basePlans.html | 6 +- ...blisher_v3.monetization.subscriptions.html | 20 ++--- ...ueryreservation_v1.projects.locations.html | 4 +- ...ts.locations.reservations.assignments.html | 12 +-- ...sinessprofileperformance_v1.locations.html | 10 +-- docs/dyn/classroom_v1.courses.html | 2 +- docs/dyn/cloudasset_v1.assets.html | 8 +- docs/dyn/cloudasset_v1.v1.html | 20 ++--- .../dyn/cloudasset_v1beta1.organizations.html | 8 +- docs/dyn/cloudasset_v1beta1.projects.html | 8 +- docs/dyn/cloudasset_v1p5beta1.assets.html | 8 +- docs/dyn/gmail_v1.users.labels.html | 32 ++++---- ...v1.projects.locations.connectClusters.html | 8 +- ...untmanagement_v1.accounts.invitations.html | 2 +- .../oracledatabase_v1.projects.locations.html | 4 +- ...saasservicemgmt_v1.projects.locations.html | 4 +- ...ervicemgmt_v1beta1.projects.locations.html | 4 +- ...vicemanagement_v1.enterprises.devices.html | 8 +- ...atintelligence_v1beta.projects.alerts.html | 74 +++++++++---------- .../documents/androidpublisher.v3.json | 4 +- .../documents/bigqueryreservation.v1.json | 6 +- .../businessprofileperformance.v1.json | 8 +- .../documents/classroom.v1.json | 4 +- .../documents/cloudasset.v1.json | 10 +-- .../documents/cloudasset.v1beta1.json | 6 +- .../documents/cloudasset.v1p1beta1.json | 6 +- .../documents/cloudasset.v1p5beta1.json | 6 +- .../documents/cloudasset.v1p7beta1.json | 6 +- .../documents/datalineage.v1.json | 4 +- .../documents/datamanager.v1.json | 39 +++++++++- .../discovery_cache/documents/gmail.v1.json | 6 +- .../documents/managedkafka.v1.json | 4 +- .../mybusinessaccountmanagement.v1.json | 4 +- .../documents/mybusinessverifications.v1.json | 8 +- .../documents/oracledatabase.v1.json | 4 +- .../documents/saasservicemgmt.v1.json | 4 +- .../documents/saasservicemgmt.v1beta1.json | 4 +- .../documents/smartdevicemanagement.v1.json | 6 +- .../documents/threatintelligence.v1beta.json | 16 ++-- 39 files changed, 213 insertions(+), 184 deletions(-) diff --git a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html index 911e75d116..3cde316e92 100644 --- a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html +++ b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html @@ -191,7 +191,7 @@ Method Details
"benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. "A String", ], - "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 200 characters. Plain text. "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 subscription in the language of this listing. Plain text. }, @@ -374,7 +374,7 @@Method Details
"benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. "A String", ], - "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 200 characters. Plain text. "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 subscription in the language of this listing. Plain text. }, @@ -504,7 +504,7 @@Method Details
"benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. "A String", ], - "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 200 characters. Plain text. "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 subscription in the language of this listing. Plain text. }, diff --git a/docs/dyn/androidpublisher_v3.monetization.subscriptions.html b/docs/dyn/androidpublisher_v3.monetization.subscriptions.html index 5ecf0077b8..403d2ca5d1 100644 --- a/docs/dyn/androidpublisher_v3.monetization.subscriptions.html +++ b/docs/dyn/androidpublisher_v3.monetization.subscriptions.html @@ -195,7 +195,7 @@Method Details
"benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. "A String", ], - "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 200 characters. Plain text. "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 subscription in the language of this listing. Plain text. }, @@ -309,7 +309,7 @@Method Details
"benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. "A String", ], - "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 200 characters. Plain text. "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 subscription in the language of this listing. Plain text. }, @@ -425,7 +425,7 @@Method Details
"benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. "A String", ], - "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 200 characters. Plain text. "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 subscription in the language of this listing. Plain text. }, @@ -535,7 +535,7 @@Method Details
"benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. "A String", ], - "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 200 characters. Plain text. "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 subscription in the language of this listing. Plain text. }, @@ -648,7 +648,7 @@Method Details
"benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. "A String", ], - "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 200 characters. Plain text. "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 subscription in the language of this listing. Plain text. }, @@ -754,7 +754,7 @@Method Details
"benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. "A String", ], - "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 200 characters. Plain text. "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 subscription in the language of this listing. Plain text. }, @@ -880,7 +880,7 @@Method Details
"benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. "A String", ], - "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 200 characters. Plain text. "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 subscription in the language of this listing. Plain text. }, @@ -997,7 +997,7 @@Method Details
"benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. "A String", ], - "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 200 characters. Plain text. "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 subscription in the language of this listing. Plain text. }, @@ -1120,7 +1120,7 @@Method Details
"benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. "A String", ], - "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 200 characters. Plain text. "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 subscription in the language of this listing. Plain text. }, @@ -1232,7 +1232,7 @@Method Details
"benefits": [ # A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits. "A String", ], - "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text. + "description": "A String", # The description of this subscription in the language of this listing. Maximum length - 200 characters. Plain text. "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 subscription in the language of this listing. Plain text. }, diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.html b/docs/dyn/bigqueryreservation_v1.projects.locations.html index ac67e9cb09..62b65f8740 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.html @@ -168,7 +168,7 @@Method Details
"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -218,7 +218,7 @@Method Details
"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html index 198379af9a..d096c0bf2a 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html @@ -124,7 +124,7 @@Method Details
"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -146,7 +146,7 @@Method Details
"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -244,7 +244,7 @@Method Details
"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -297,7 +297,7 @@Method Details
"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -320,7 +320,7 @@Method Details
"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -342,7 +342,7 @@Method Details
"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. diff --git a/docs/dyn/businessprofileperformance_v1.locations.html b/docs/dyn/businessprofileperformance_v1.locations.html index d9cdf94310..006bb31008 100644 --- a/docs/dyn/businessprofileperformance_v1.locations.html +++ b/docs/dyn/businessprofileperformance_v1.locations.html @@ -84,10 +84,10 @@Instance Methods
Close httplib2 connections.
-Returns the values for each date from a given time range and optionally the sub entity type, where applicable, that are associated with the specific daily metrics. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:fetchMultiDailyMetricsTimeSeries?dailyMetrics=WEBSITE_CLICKS&dailyMetrics=CALL_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31`
+Returns the values for each date from a given time range that are associated with the specific daily metrics. Note: Only daily data is available. Hourly metrics are not supported. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:fetchMultiDailyMetricsTimeSeries?dailyMetrics=WEBSITE_CLICKS&dailyMetrics=CALL_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31`
-Returns the values for each date from a given time range that are associated with the specific daily metric. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:getDailyMetricsTimeSeries?dailyMetric=WEBSITE_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31`
+Returns the values for each date from a given time range that are associated with the specific daily metric. Note: Only daily data is available. Hourly metrics are not supported. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:getDailyMetricsTimeSeries?dailyMetric=WEBSITE_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31`
Method Details
close()@@ -96,7 +96,7 @@Method Details
fetchMultiDailyMetricsTimeSeries(location, dailyMetrics=None, dailyRange_endDate_day=None, dailyRange_endDate_month=None, dailyRange_endDate_year=None, dailyRange_startDate_day=None, dailyRange_startDate_month=None, dailyRange_startDate_year=None, x__xgafv=None)-Returns the values for each date from a given time range and optionally the sub entity type, where applicable, that are associated with the specific daily metrics. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:fetchMultiDailyMetricsTimeSeries?dailyMetrics=WEBSITE_CLICKS&dailyMetrics=CALL_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31` +Returns the values for each date from a given time range that are associated with the specific daily metrics. Note: Only daily data is available. Hourly metrics are not supported. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:fetchMultiDailyMetricsTimeSeries?dailyMetrics=WEBSITE_CLICKS&dailyMetrics=CALL_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31` Args: location: string, Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id. (required) @@ -134,7 +134,7 @@Method Details
"dailyMetricTimeSeries": [ # List of DailyMetric-TimeSeries pairs. { # Represents a single datapoint, where each datapoint is a DailyMetric-DailySubEntityType-TimeSeries tuple. "dailyMetric": "A String", # The DailyMetric that the TimeSeries represents. - "dailySubEntityType": { # Represents all possible subentity types that are associated with DailyMetrics. # The DailySubEntityType that the TimeSeries represents. Will not be present when breakdown does not exist. + "dailySubEntityType": { # Represents all possible subentity types that are associated with DailyMetrics. Note: Currently, all metrics are returned as daily aggregates and sub-entity breakdowns are not supported. # The DailySubEntityType that the TimeSeries represents. Will not be present when breakdown does not exist. "dayOfWeek": "A String", # Represents the day of the week. Eg: MONDAY. Currently supported DailyMetrics = NONE. "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Represents the time of the day in 24 hour format. Eg: 13:34:20 Currently supported DailyMetrics = NONE. "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. @@ -164,7 +164,7 @@Method Details
getDailyMetricsTimeSeries(name, dailyMetric=None, dailyRange_endDate_day=None, dailyRange_endDate_month=None, dailyRange_endDate_year=None, dailyRange_startDate_day=None, dailyRange_startDate_month=None, dailyRange_startDate_year=None, dailySubEntityType_dayOfWeek=None, dailySubEntityType_timeOfDay_hours=None, dailySubEntityType_timeOfDay_minutes=None, dailySubEntityType_timeOfDay_nanos=None, dailySubEntityType_timeOfDay_seconds=None, x__xgafv=None)-Returns the values for each date from a given time range that are associated with the specific daily metric. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:getDailyMetricsTimeSeries?dailyMetric=WEBSITE_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31` +Returns the values for each date from a given time range that are associated with the specific daily metric. Note: Only daily data is available. Hourly metrics are not supported. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:getDailyMetricsTimeSeries?dailyMetric=WEBSITE_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31` Args: name: string, Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id. (required) diff --git a/docs/dyn/classroom_v1.courses.html b/docs/dyn/classroom_v1.courses.html index ed53324c84..ae740c6cd4 100644 --- a/docs/dyn/classroom_v1.courses.html +++ b/docs/dyn/classroom_v1.courses.html @@ -452,7 +452,7 @@Method Details
Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist. Args: - courseStates: string, Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. (repeated) + courseStates: string, Restricts returned courses to those in one of the specified states. If unspecified, Courses in any state are returned. (repeated) Allowed values COURSE_STATE_UNSPECIFIED - No course state. No returned Course message will use this value. ACTIVE - The course is active. diff --git a/docs/dyn/cloudasset_v1.assets.html b/docs/dyn/cloudasset_v1.assets.html index e8fe13c42d..2465450523 100644 --- a/docs/dyn/cloudasset_v1.assets.html +++ b/docs/dyn/cloudasset_v1.assets.html @@ -468,7 +468,7 @@Method Details
"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -508,7 +508,7 @@Method Details
"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -561,7 +561,7 @@Method Details
"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -601,7 +601,7 @@Method Details
"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. diff --git a/docs/dyn/cloudasset_v1.v1.html b/docs/dyn/cloudasset_v1.v1.html index 64b8545813..a33e39ef3d 100644 --- a/docs/dyn/cloudasset_v1.v1.html +++ b/docs/dyn/cloudasset_v1.v1.html @@ -414,7 +414,7 @@Method Details
"writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table or partition already exists. The following values are supported: * WRITE_TRUNCATE: If the table or partition already exists, BigQuery overwrites the entire table or all the partitions data. * WRITE_APPEND: If the table or partition already exists, BigQuery appends the data to the table or the latest partition. * WRITE_EMPTY: If the table already exists and contains data, an error is returned. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Details are at https://cloud.google.com/bigquery/docs/loading-data-local#appending_to_or_overwriting_a_table_using_a_local_file. }, "gcsDestination": { # A Cloud Storage location. # Destination on Cloud Storage. - "uri": "A String", # Required. The URI of the Cloud Storage object. It's the same URI that is used by gsutil. Example: "gs://bucket_name/object_name". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information. If the specified Cloud Storage object already exists and there is no [hold](https://cloud.google.com/storage/docs/object-holds), it will be overwritten with the analysis result. + "uri": "A String", # Required. The URI of the Cloud Storage object. It's the same URI that is used by gcloud storage. Example: "gs://bucket_name/object_name". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information. If the specified Cloud Storage object already exists and there is no [hold](https://cloud.google.com/storage/docs/object-holds), it will be overwritten with the analysis result. }, }, "savedAnalysisQuery": "A String", # Optional. The name of a saved query, which must be in the format of: * projects/project_number/savedQueries/saved_query_id * folders/folder_number/savedQueries/saved_query_id * organizations/organization_number/savedQueries/saved_query_id If both `analysis_query` and `saved_analysis_query` are provided, they will be merged together with the `saved_analysis_query` as base and the `analysis_query` as overrides. For more details of the merge behavior, refer to the [MergeFrom](https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.message#Message.MergeFrom.details) doc. Note that you cannot override primitive fields with default value, such as 0 or empty string, etc., because we use proto3, which doesn't support field presence yet. @@ -1356,7 +1356,7 @@Method Details
"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1396,7 +1396,7 @@Method Details
"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1449,7 +1449,7 @@Method Details
"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1489,7 +1489,7 @@Method Details
"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1890,7 +1890,7 @@Method Details
"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1930,7 +1930,7 @@Method Details
"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1983,7 +1983,7 @@Method Details
"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -2023,7 +2023,7 @@Method Details
"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -2114,7 +2114,7 @@Method Details
"table": "A String", # Required. The BigQuery table to which the snapshot result should be written. If this table does not exist, a new table with the given name will be created. }, "gcsDestination": { # A Cloud Storage location. # Destination on Cloud Storage. - "uri": "A String", # The URI of the Cloud Storage object. It's the same URI that is used by gsutil. Example: "gs://bucket_name/object_name". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information. If the specified Cloud Storage object already exists and there is no [hold](https://cloud.google.com/storage/docs/object-holds), it will be overwritten with the exported result. + "uri": "A String", # The URI of the Cloud Storage object. It's the same URI that is used by gcloud storage. Example: "gs://bucket_name/object_name". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information. If the specified Cloud Storage object already exists and there is no [hold](https://cloud.google.com/storage/docs/object-holds), it will be overwritten with the exported result. "uriPrefix": "A String", # The URI prefix of all generated Cloud Storage objects. Example: "gs://bucket_name/object_name_prefix". Each object URI is in format: "gs://bucket_name/object_name_prefix// and only contains assets for that type. starts from 0. Example: "gs://bucket_name/object_name_prefix/compute.googleapis.com/Disk/0" is the first shard of output objects containing all compute.googleapis.com/Disk assets. An INVALID_ARGUMENT error will be returned if file with the same name "gs://bucket_name/object_name_prefix" already exists. }, }, diff --git a/docs/dyn/cloudasset_v1beta1.organizations.html b/docs/dyn/cloudasset_v1beta1.organizations.html index 10910d9d04..df598d1255 100644 --- a/docs/dyn/cloudasset_v1beta1.organizations.html +++ b/docs/dyn/cloudasset_v1beta1.organizations.html @@ -264,7 +264,7 @@Method Details
"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -304,7 +304,7 @@Method Details
"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -357,7 +357,7 @@Method Details
"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -397,7 +397,7 @@Method Details
"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. diff --git a/docs/dyn/cloudasset_v1beta1.projects.html b/docs/dyn/cloudasset_v1beta1.projects.html index 1ebef9f0e7..5147790e13 100644 --- a/docs/dyn/cloudasset_v1beta1.projects.html +++ b/docs/dyn/cloudasset_v1beta1.projects.html @@ -264,7 +264,7 @@Method Details
"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -304,7 +304,7 @@Method Details
"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -357,7 +357,7 @@Method Details
"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -397,7 +397,7 @@Method Details
"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. diff --git a/docs/dyn/cloudasset_v1p5beta1.assets.html b/docs/dyn/cloudasset_v1p5beta1.assets.html index 7fb87522e5..a6eaed1ae8 100644 --- a/docs/dyn/cloudasset_v1p5beta1.assets.html +++ b/docs/dyn/cloudasset_v1p5beta1.assets.html @@ -269,7 +269,7 @@Method Details
"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -309,7 +309,7 @@Method Details
"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -362,7 +362,7 @@Method Details
"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -402,7 +402,7 @@Method Details
"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. diff --git a/docs/dyn/gmail_v1.users.labels.html b/docs/dyn/gmail_v1.users.labels.html index 04450ae285..193bf4b72c 100644 --- a/docs/dyn/gmail_v1.users.labels.html +++ b/docs/dyn/gmail_v1.users.labels.html @@ -112,8 +112,8 @@Method Details
{ # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. @@ -136,8 +136,8 @@Method Details
{ # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. @@ -182,8 +182,8 @@Method Details
{ # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. @@ -215,8 +215,8 @@Method Details
"labels": [ # List of labels. Note that each label resource only contains an `id`, `name`, `messageListVisibility`, `labelListVisibility`, and `type`. The [`labels.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/labels/get) method can fetch additional label details. { # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. @@ -244,8 +244,8 @@Method Details
{ # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. @@ -268,8 +268,8 @@Method Details
{ # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. @@ -295,8 +295,8 @@Method Details
{ # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. @@ -319,8 +319,8 @@Method Details
{ # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. diff --git a/docs/dyn/managedkafka_v1.projects.locations.connectClusters.html b/docs/dyn/managedkafka_v1.projects.locations.connectClusters.html index c7c3fc1c8c..6029234239 100644 --- a/docs/dyn/managedkafka_v1.projects.locations.connectClusters.html +++ b/docs/dyn/managedkafka_v1.projects.locations.connectClusters.html @@ -120,7 +120,7 @@Method Details
"memoryBytes": "A String", # Required. The memory to provision for the cluster in bytes. The CPU:memory ratio (vCPU:GiB) must be between 1:1 and 1:8. Minimum: 3221225472 (3 GiB). "vcpuCount": "A String", # Required. The number of vCPUs to provision for the cluster. Minimum: 3. }, - "config": { # Optional. Configurations for the worker that are overridden from the defaults. The key of the map is a Kafka Connect worker property name, for example: `exactly.once.source.support`. + "config": { # Optional. Reserved for future use. This field is meant for worker config overrides, but is unsupported for now. "a_key": "A String", }, "createTime": "A String", # Output only. The time when the cluster was created. @@ -239,7 +239,7 @@Method Details
"memoryBytes": "A String", # Required. The memory to provision for the cluster in bytes. The CPU:memory ratio (vCPU:GiB) must be between 1:1 and 1:8. Minimum: 3221225472 (3 GiB). "vcpuCount": "A String", # Required. The number of vCPUs to provision for the cluster. Minimum: 3. }, - "config": { # Optional. Configurations for the worker that are overridden from the defaults. The key of the map is a Kafka Connect worker property name, for example: `exactly.once.source.support`. + "config": { # Optional. Reserved for future use. This field is meant for worker config overrides, but is unsupported for now. "a_key": "A String", }, "createTime": "A String", # Output only. The time when the cluster was created. @@ -298,7 +298,7 @@Method Details
"memoryBytes": "A String", # Required. The memory to provision for the cluster in bytes. The CPU:memory ratio (vCPU:GiB) must be between 1:1 and 1:8. Minimum: 3221225472 (3 GiB). "vcpuCount": "A String", # Required. The number of vCPUs to provision for the cluster. Minimum: 3. }, - "config": { # Optional. Configurations for the worker that are overridden from the defaults. The key of the map is a Kafka Connect worker property name, for example: `exactly.once.source.support`. + "config": { # Optional. Reserved for future use. This field is meant for worker config overrides, but is unsupported for now. "a_key": "A String", }, "createTime": "A String", # Output only. The time when the cluster was created. @@ -366,7 +366,7 @@Method Details
"memoryBytes": "A String", # Required. The memory to provision for the cluster in bytes. The CPU:memory ratio (vCPU:GiB) must be between 1:1 and 1:8. Minimum: 3221225472 (3 GiB). "vcpuCount": "A String", # Required. The number of vCPUs to provision for the cluster. Minimum: 3. }, - "config": { # Optional. Configurations for the worker that are overridden from the defaults. The key of the map is a Kafka Connect worker property name, for example: `exactly.once.source.support`. + "config": { # Optional. Reserved for future use. This field is meant for worker config overrides, but is unsupported for now. "a_key": "A String", }, "createTime": "A String", # Output only. The time when the cluster was created. diff --git a/docs/dyn/mybusinessaccountmanagement_v1.accounts.invitations.html b/docs/dyn/mybusinessaccountmanagement_v1.accounts.invitations.html index 14040b36cc..022c1b821d 100644 --- a/docs/dyn/mybusinessaccountmanagement_v1.accounts.invitations.html +++ b/docs/dyn/mybusinessaccountmanagement_v1.accounts.invitations.html @@ -193,7 +193,7 @@Method Details
"vettedState": "A String", # Output only. Indicates whether the account is vetted by Google. A vetted account is able to verify locations via the VETTED_PARTNER method. }, "targetLocation": { # Represents a target location for a pending invitation. # The target location this invitation is for. - "address": "A String", # The address of the location to which the user is invited. + "address": "A String", # The address of the location to which the user is invited. Not always populated. "locationName": "A String", # The name of the location to which the user is invited. }, "targetType": "A String", # Output only. Specifies which target types should appear in the response. diff --git a/docs/dyn/oracledatabase_v1.projects.locations.html b/docs/dyn/oracledatabase_v1.projects.locations.html index 1dee6694b1..118c21904f 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.html @@ -177,7 +177,7 @@Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -216,7 +216,7 @@Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/saasservicemgmt_v1.projects.locations.html b/docs/dyn/saasservicemgmt_v1.projects.locations.html index a82c719b6f..d770ddf7c5 100644 --- a/docs/dyn/saasservicemgmt_v1.projects.locations.html +++ b/docs/dyn/saasservicemgmt_v1.projects.locations.html @@ -122,7 +122,7 @@Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -161,7 +161,7 @@Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html index 3f5bc95412..9fea558238 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html @@ -142,7 +142,7 @@Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -181,7 +181,7 @@Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/smartdevicemanagement_v1.enterprises.devices.html b/docs/dyn/smartdevicemanagement_v1.enterprises.devices.html index e332c8b81e..b2260768cb 100644 --- a/docs/dyn/smartdevicemanagement_v1.enterprises.devices.html +++ b/docs/dyn/smartdevicemanagement_v1.enterprises.devices.html @@ -138,12 +138,12 @@Method Details
An object of the form: { # Device resource represents an instance of enterprise managed device in the property. - "ghpName": "A String", # Output only. The GHP device ID of the device. + "ghpName": "A String", # Output only. The Home APIs device ID of the device. "name": "A String", # Required. The resource name of the device. For example: "enterprises/XYZ/devices/123". "parentRelations": [ # Assignee details of the device. { # Represents device relationships, for instance, structure/room to which the device is assigned to. "displayName": "A String", # Output only. The custom name of the relation -- e.g., structure/room where the device is assigned to. - "ghpParent": "A String", # Output only. The GHP name of the relation -- e.g., structure/room where the device is assigned to. For example: "homegraph.googleapis.com/Structure/ABC" or "homegraph.googleapis.com/Room/ABC" + "ghpParent": "A String", # Output only. The Home APIs name of the relation -- e.g., structure/room where the device is assigned to. For example: "homegraph.googleapis.com/Structure/ABC" or "homegraph.googleapis.com/Room/ABC" "parent": "A String", # Output only. The name of the relation -- e.g., structure/room where the device is assigned to. For example: "enterprises/XYZ/structures/ABC" or "enterprises/XYZ/structures/ABC/rooms/123" }, ], @@ -172,12 +172,12 @@Method Details
{ # Response message for SmartDeviceManagementService.ListDevices "devices": [ # The list of devices. { # Device resource represents an instance of enterprise managed device in the property. - "ghpName": "A String", # Output only. The GHP device ID of the device. + "ghpName": "A String", # Output only. The Home APIs device ID of the device. "name": "A String", # Required. The resource name of the device. For example: "enterprises/XYZ/devices/123". "parentRelations": [ # Assignee details of the device. { # Represents device relationships, for instance, structure/room to which the device is assigned to. "displayName": "A String", # Output only. The custom name of the relation -- e.g., structure/room where the device is assigned to. - "ghpParent": "A String", # Output only. The GHP name of the relation -- e.g., structure/room where the device is assigned to. For example: "homegraph.googleapis.com/Structure/ABC" or "homegraph.googleapis.com/Room/ABC" + "ghpParent": "A String", # Output only. The Home APIs name of the relation -- e.g., structure/room where the device is assigned to. For example: "homegraph.googleapis.com/Structure/ABC" or "homegraph.googleapis.com/Room/ABC" "parent": "A String", # Output only. The name of the relation -- e.g., structure/room where the device is assigned to. For example: "enterprises/XYZ/structures/ABC" or "enterprises/XYZ/structures/ABC/rooms/123" }, ], diff --git a/docs/dyn/threatintelligence_v1beta.projects.alerts.html b/docs/dyn/threatintelligence_v1beta.projects.alerts.html index 238a09b9fd..eb51624cc6 100644 --- a/docs/dyn/threatintelligence_v1beta.projects.alerts.html +++ b/docs/dyn/threatintelligence_v1beta.projects.alerts.html @@ -158,20 +158,20 @@Method Details
"discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. Data Leak specific severity This will be the string representation of the DataLeakFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Data Leak alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union. "initialAccessBroker": { # Captures the specific details of InitialAccessBroker (IAB) alert. # Initial Access Broker alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. IAB specific severity + "severity": "A String", # Required. The severity of the Initial Access Broker (IAB) alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "insiderThreat": { # Captures the specific details of InsiderThreat alert. # Insider Threat alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. InsiderThreat specific severity This will be the string representation of the InsiderThreatFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Insider Threat alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, }, "displayName": "A String", # Output only. A short title for the alert. @@ -256,20 +256,20 @@Method Details
"discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. Data Leak specific severity This will be the string representation of the DataLeakFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Data Leak alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union. "initialAccessBroker": { # Captures the specific details of InitialAccessBroker (IAB) alert. # Initial Access Broker alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. IAB specific severity + "severity": "A String", # Required. The severity of the Initial Access Broker (IAB) alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "insiderThreat": { # Captures the specific details of InsiderThreat alert. # Insider Threat alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. InsiderThreat specific severity This will be the string representation of the InsiderThreatFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Insider Threat alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, }, "displayName": "A String", # Output only. A short title for the alert. @@ -382,20 +382,20 @@Method Details
"discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. Data Leak specific severity This will be the string representation of the DataLeakFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Data Leak alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union. "initialAccessBroker": { # Captures the specific details of InitialAccessBroker (IAB) alert. # Initial Access Broker alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. IAB specific severity + "severity": "A String", # Required. The severity of the Initial Access Broker (IAB) alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "insiderThreat": { # Captures the specific details of InsiderThreat alert. # Insider Threat alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. InsiderThreat specific severity This will be the string representation of the InsiderThreatFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Insider Threat alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, }, "displayName": "A String", # Output only. A short title for the alert. @@ -474,20 +474,20 @@Method Details
"discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. Data Leak specific severity This will be the string representation of the DataLeakFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Data Leak alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union. "initialAccessBroker": { # Captures the specific details of InitialAccessBroker (IAB) alert. # Initial Access Broker alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. IAB specific severity + "severity": "A String", # Required. The severity of the Initial Access Broker (IAB) alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "insiderThreat": { # Captures the specific details of InsiderThreat alert. # Insider Threat alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. InsiderThreat specific severity This will be the string representation of the InsiderThreatFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Insider Threat alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, }, "displayName": "A String", # Output only. A short title for the alert. @@ -560,20 +560,20 @@Method Details
"discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. Data Leak specific severity This will be the string representation of the DataLeakFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Data Leak alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union. "initialAccessBroker": { # Captures the specific details of InitialAccessBroker (IAB) alert. # Initial Access Broker alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. IAB specific severity + "severity": "A String", # Required. The severity of the Initial Access Broker (IAB) alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "insiderThreat": { # Captures the specific details of InsiderThreat alert. # Insider Threat alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. InsiderThreat specific severity This will be the string representation of the InsiderThreatFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Insider Threat alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, }, "displayName": "A String", # Output only. A short title for the alert. @@ -622,10 +622,10 @@Method Details
Args: parent: string, Required. Parent of the alerts. Format: projects/{project} (required) - filter: string, Optional. Filter criteria. - orderBy: string, Optional. Order by criteria in the csv format: "field1,field2 desc" or "field1,field2" or "field1 asc, field2". - pageSize: integer, Optional. Page size. - pageToken: string, Optional. Page token. + filter: string, Optional. Filter criteria. Supported fields for filtering include: * `audit.create_time` * `audit.creator` * `audit.update_time` * `audit.updater` * `detail.data_leak.discovery_document_ids` * `detail.data_leak.severity` * `detail.detail_type` * `detail.initial_access_broker.discovery_document_ids` * `detail.initial_access_broker.severity` * `detail.insider_threat.discovery_document_ids` * `detail.insider_threat.severity` * `finding_count` * `priority_analysis.priority_level` * `relevance_analysis.confidence` * `relevance_analysis.relevance_level` * `relevance_analysis.relevant` * `severity_analysis.severity_level` * `state` Examples: * `detail.detail_type = "initial_access_broker"` * `detail.detail_type != "data_leak"` * `detail.insider_threat.severity = "HIGH"` * `audit.create_time >= "2026-04-03T00:00:00Z" AND audit.create_time < "2026-04-06T00:00:00Z"` * `state = "NEW" OR state = "TRIAGED"` * `severity_analysis.severity_level = "SEVERITY_LEVEL_CRITICAL"` + orderBy: string, Optional. Order by criteria in the csv format: "field1, field2 desc" or "field1, field2" or "field1 asc, field2". If a field is specified without `asc` or `desc`, ascending order is used by default. Supported fields for ordering are identical to those supported for filtering. Examples: * `audit.create_time desc` * `audit.update_time asc` * `audit.create_time desc, severity_analysis.severity_level desc` + pageSize: integer, Optional. Page size. Default to 100 alerts per page. Maximum is 1000 alerts per page. + pageToken: string, Optional. Page token to retrieve the next page of results. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -652,20 +652,20 @@Method Details
"discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. Data Leak specific severity This will be the string representation of the DataLeakFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Data Leak alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union. "initialAccessBroker": { # Captures the specific details of InitialAccessBroker (IAB) alert. # Initial Access Broker alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. IAB specific severity + "severity": "A String", # Required. The severity of the Initial Access Broker (IAB) alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "insiderThreat": { # Captures the specific details of InsiderThreat alert. # Insider Threat alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. InsiderThreat specific severity This will be the string representation of the InsiderThreatFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Insider Threat alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, }, "displayName": "A String", # Output only. A short title for the alert. @@ -761,20 +761,20 @@Method Details
"discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. Data Leak specific severity This will be the string representation of the DataLeakFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Data Leak alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union. "initialAccessBroker": { # Captures the specific details of InitialAccessBroker (IAB) alert. # Initial Access Broker alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. IAB specific severity + "severity": "A String", # Required. The severity of the Initial Access Broker (IAB) alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "insiderThreat": { # Captures the specific details of InsiderThreat alert. # Insider Threat alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. InsiderThreat specific severity This will be the string representation of the InsiderThreatFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Insider Threat alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, }, "displayName": "A String", # Output only. A short title for the alert. @@ -853,20 +853,20 @@Method Details
"discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. Data Leak specific severity This will be the string representation of the DataLeakFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Data Leak alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union. "initialAccessBroker": { # Captures the specific details of InitialAccessBroker (IAB) alert. # Initial Access Broker alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. IAB specific severity + "severity": "A String", # Required. The severity of the Initial Access Broker (IAB) alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "insiderThreat": { # Captures the specific details of InsiderThreat alert. # Insider Threat alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. InsiderThreat specific severity This will be the string representation of the InsiderThreatFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Insider Threat alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, }, "displayName": "A String", # Output only. A short title for the alert. @@ -945,20 +945,20 @@Method Details
"discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. Data Leak specific severity This will be the string representation of the DataLeakFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Data Leak alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union. "initialAccessBroker": { # Captures the specific details of InitialAccessBroker (IAB) alert. # Initial Access Broker alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. IAB specific severity + "severity": "A String", # Required. The severity of the Initial Access Broker (IAB) alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "insiderThreat": { # Captures the specific details of InsiderThreat alert. # Insider Threat alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. InsiderThreat specific severity This will be the string representation of the InsiderThreatFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Insider Threat alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, }, "displayName": "A String", # Output only. A short title for the alert. @@ -1037,20 +1037,20 @@Method Details
"discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. Data Leak specific severity This will be the string representation of the DataLeakFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Data Leak alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union. "initialAccessBroker": { # Captures the specific details of InitialAccessBroker (IAB) alert. # Initial Access Broker alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. IAB specific severity + "severity": "A String", # Required. The severity of the Initial Access Broker (IAB) alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "insiderThreat": { # Captures the specific details of InsiderThreat alert. # Insider Threat alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. InsiderThreat specific severity This will be the string representation of the InsiderThreatFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Insider Threat alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, }, "displayName": "A String", # Output only. A short title for the alert. @@ -1129,20 +1129,20 @@Method Details
"discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. Data Leak specific severity This will be the string representation of the DataLeakFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Data Leak alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union. "initialAccessBroker": { # Captures the specific details of InitialAccessBroker (IAB) alert. # Initial Access Broker alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. IAB specific severity + "severity": "A String", # Required. The severity of the Initial Access Broker (IAB) alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, "insiderThreat": { # Captures the specific details of InsiderThreat alert. # Insider Threat alert detail type. "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents "A String", ], - "severity": "A String", # Required. InsiderThreat specific severity This will be the string representation of the InsiderThreatFindingDetail.Severityenum. (e.g., "LOW", "MEDIUM", "HIGH", "CRITICAL") + "severity": "A String", # Required. The severity of the Insider Threat alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL` }, }, "displayName": "A String", # Output only. A short title for the alert. diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index 8e5a25e90b..aeabd40bf3 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -5637,7 +5637,7 @@ } } }, -"revision": "20260318", +"revision": "20260416", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -11716,7 +11716,7 @@ false "type": "array" }, "description": { -"description": "The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text.", +"description": "The description of this subscription in the language of this listing. Maximum length - 200 characters. Plain text.", "type": "string" }, "languageCode": { diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json index 6722e1f21f..60d5676117 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json @@ -1282,7 +1282,7 @@ } } }, -"revision": "20260305", +"revision": "20260410", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -1330,7 +1330,7 @@ "type": "string" }, "principal": { -"description": "Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities.", +"description": "Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users.", "type": "string" }, "schedulingPolicy": { @@ -1935,7 +1935,7 @@ false "enumDescriptions": [ "Default value of ScalingMode.", "The reservation will scale up only using slots from autoscaling. It will not use any idle slots even if there may be some available. The upper limit that autoscaling can scale up to will be max_slots - baseline. For example, if max_slots is 1000, baseline is 200 and customer sets ScalingMode to AUTOSCALE_ONLY, then autoscalerg will scale up to 800 slots and no idle slots will be used. Please note, in this mode, the ignore_idle_slots field must be set to true. Otherwise the request will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.", -"The reservation will scale up using only idle slots contributed by other reservations or from unassigned commitments. If no idle slots are available it will not scale up further. If the idle slots which it is using are reclaimed by the contributing reservation(s) it may be forced to scale down. The max idle slots the reservation can be max_slots - baseline capacity. For example, if max_slots is 1000, baseline is 200 and customer sets ScalingMode to IDLE_SLOTS_ONLY, 1. if there are 1000 idle slots available in other reservations, the reservation will scale up to 1000 slots with 200 baseline and 800 idle slots. 2. if there are 500 idle slots available in other reservations, the reservation will scale up to 700 slots with 200 baseline and 300 idle slots. Please note, in this mode, the reservation might not be able to scale up to max_slots. Please note, in this mode, the ignore_idle_slots field must be set to false. Otherwise the request will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.", +"The reservation will scale up using only idle slots contributed by other reservations or from unassigned commitments. If no idle slots are available it will not scale up further. If the idle slots which it is using are reclaimed by the contributing reservation(s) it may be forced to scale down. The max idle slots the reservation can be max_slots - baseline capacity. For example, if max_slots is 1000, baseline is 200 and customer sets ScalingMode to IDLE_SLOTS_ONLY, 1. if there are 1000 idle slots available in other reservations, the reservation will scale up to 1000 slots with 200 baseline and 800 idle slots. 2. if there are 500 idle slots available in other reservations, the reservation will scale up to 700 slots with 200 baseline and 500 idle slots. Please note, in this mode, the reservation might not be able to scale up to max_slots. Please note, in this mode, the ignore_idle_slots field must be set to false. Otherwise the request will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.", "The reservation will scale up using all slots available to it. It will use idle slots contributed by other reservations or from unassigned commitments first. If no idle slots are available it will scale up using autoscaling. For example, if max_slots is 1000, baseline is 200 and customer sets ScalingMode to ALL_SLOTS, 1. if there are 800 idle slots available in other reservations, the reservation will scale up to 1000 slots with 200 baseline and 800 idle slots. 2. if there are 500 idle slots available in other reservations, the reservation will scale up to 1000 slots with 200 baseline, 500 idle slots and 300 autoscaling slots. 3. if there are no idle slots available in other reservations, it will scale up to 1000 slots with 200 baseline and 800 autoscaling slots. Please note, in this mode, the ignore_idle_slots field must be set to false. Otherwise the request will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`." ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json index a2a1fffa5b..e7878436dc 100644 --- a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +++ b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json @@ -99,7 +99,7 @@ "locations": { "methods": { "fetchMultiDailyMetricsTimeSeries": { -"description": " Returns the values for each date from a given time range and optionally the sub entity type, where applicable, that are associated with the specific daily metrics. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:fetchMultiDailyMetricsTimeSeries?dailyMetrics=WEBSITE_CLICKS&dailyMetrics=CALL_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31`", +"description": " Returns the values for each date from a given time range that are associated with the specific daily metrics. Note: Only daily data is available. Hourly metrics are not supported. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:fetchMultiDailyMetricsTimeSeries?dailyMetrics=WEBSITE_CLICKS&dailyMetrics=CALL_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31`", "flatPath": "v1/locations/{locationsId}:fetchMultiDailyMetricsTimeSeries", "httpMethod": "GET", "id": "businessprofileperformance.locations.fetchMultiDailyMetricsTimeSeries", @@ -205,7 +205,7 @@ false } }, "getDailyMetricsTimeSeries": { -"description": " Returns the values for each date from a given time range that are associated with the specific daily metric. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:getDailyMetricsTimeSeries?dailyMetric=WEBSITE_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31`", +"description": " Returns the values for each date from a given time range that are associated with the specific daily metric. Note: Only daily data is available. Hourly metrics are not supported. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:getDailyMetricsTimeSeries?dailyMetric=WEBSITE_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31`", "flatPath": "v1/locations/{locationsId}:getDailyMetricsTimeSeries", "httpMethod": "GET", "id": "businessprofileperformance.locations.getDailyMetricsTimeSeries", @@ -445,7 +445,7 @@ false } } }, -"revision": "20251026", +"revision": "20260415", "rootUrl": "https://businessprofileperformance.googleapis.com/", "schemas": { "DailyMetricTimeSeries": { @@ -510,7 +510,7 @@ false "type": "object" }, "DailySubEntityType": { -"description": "Represents all possible subentity types that are associated with DailyMetrics.", +"description": "Represents all possible subentity types that are associated with DailyMetrics. Note: Currently, all metrics are returned as daily aggregates and sub-entity breakdowns are not supported.", "id": "DailySubEntityType", "properties": { "dayOfWeek": { diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json index 58db2c6571..74047506bc 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -275,7 +275,7 @@ "parameterOrder": [], "parameters": { "courseStates": { -"description": "Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.", +"description": "Restricts returned courses to those in one of the specified states. If unspecified, Courses in any state are returned.", "enum": [ "COURSE_STATE_UNSPECIFIED", "ACTIVE", @@ -4366,7 +4366,7 @@ } } }, -"revision": "20260407", +"revision": "20260414", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1.json index ff0adbc038..764a0916ab 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1.json @@ -1095,7 +1095,7 @@ } } }, -"revision": "20260314", +"revision": "20260417", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -1836,7 +1836,7 @@ "id": "GcsDestination", "properties": { "uri": { -"description": "The URI of the Cloud Storage object. It's the same URI that is used by gsutil. Example: \"gs://bucket_name/object_name\". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information. If the specified Cloud Storage object already exists and there is no [hold](https://cloud.google.com/storage/docs/object-holds), it will be overwritten with the exported result.", +"description": "The URI of the Cloud Storage object. It's the same URI that is used by gcloud storage. Example: \"gs://bucket_name/object_name\". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information. If the specified Cloud Storage object already exists and there is no [hold](https://cloud.google.com/storage/docs/object-holds), it will be overwritten with the exported result.", "type": "string" }, "uriPrefix": { @@ -2163,7 +2163,7 @@ "id": "GoogleCloudAssetV1GcsDestination", "properties": { "uri": { -"description": "Required. The URI of the Cloud Storage object. It's the same URI that is used by gsutil. Example: \"gs://bucket_name/object_name\". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information. If the specified Cloud Storage object already exists and there is no [hold](https://cloud.google.com/storage/docs/object-holds), it will be overwritten with the analysis result.", +"description": "Required. The URI of the Cloud Storage object. It's the same URI that is used by gcloud storage. Example: \"gs://bucket_name/object_name\". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information. If the specified Cloud Storage object already exists and there is no [hold](https://cloud.google.com/storage/docs/object-holds), it will be overwritten with the analysis result.", "type": "string" } }, @@ -2844,7 +2844,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", +"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", "items": { "type": "string" }, @@ -2964,7 +2964,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", +"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json index f976635343..a4c431197a 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json @@ -411,7 +411,7 @@ } } }, -"revision": "20260314", +"revision": "20260417", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -1124,7 +1124,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", +"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", "items": { "type": "string" }, @@ -1244,7 +1244,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", +"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json index b4d354f702..5f13c7cc87 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json @@ -207,7 +207,7 @@ } } }, -"revision": "20260314", +"revision": "20260417", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -826,7 +826,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", +"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", "items": { "type": "string" }, @@ -946,7 +946,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", +"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json index d21eb1147f..4b478bd6af 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json @@ -177,7 +177,7 @@ } } }, -"revision": "20260314", +"revision": "20260417", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -831,7 +831,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", +"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", "items": { "type": "string" }, @@ -951,7 +951,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", +"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json index b35556519a..331482da18 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json @@ -167,7 +167,7 @@ } } }, -"revision": "20260314", +"revision": "20260417", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -900,7 +900,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", +"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", "items": { "type": "string" }, @@ -1020,7 +1020,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", +"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, third-party identity, or agent identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/datalineage.v1.json b/googleapiclient/discovery_cache/documents/datalineage.v1.json index 959f3eb744..6392cac5b5 100644 --- a/googleapiclient/discovery_cache/documents/datalineage.v1.json +++ b/googleapiclient/discovery_cache/documents/datalineage.v1.json @@ -1247,7 +1247,7 @@ } } }, -"revision": "20260406", +"revision": "20260410", "rootUrl": "https://datalineage.googleapis.com/", "schemas": { "GoogleCloudDatacatalogLineageConfigmanagementV1Config": { @@ -1591,6 +1591,7 @@ "LOOKER_STUDIO", "DATAPROC", "VERTEX_AI", +"DATAFLOW", "LOOKER_CORE" ], "enumDescriptions": [ @@ -1602,6 +1603,7 @@ "Looker Studio", "Dataproc", "Vertex AI", +"Dataflow", "Looker Core" ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/datamanager.v1.json b/googleapiclient/discovery_cache/documents/datamanager.v1.json index 5e2a0c58f0..4c08461467 100644 --- a/googleapiclient/discovery_cache/documents/datamanager.v1.json +++ b/googleapiclient/discovery_cache/documents/datamanager.v1.json @@ -814,7 +814,7 @@ } } }, -"revision": "20260321", +"revision": "20260417", "rootUrl": "https://datamanager.googleapis.com/", "schemas": { "AdIdentifiers": { @@ -1167,7 +1167,39 @@ "PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED", "PROCESSING_ERROR_REASON_AWS_AUTH_FAILED", "PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR", -"PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER" +"PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER", +"PROCESSING_ERROR_REASON_ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +true ], "enumDescriptions": [ "The processing error reason is unknown.", @@ -1197,7 +1229,8 @@ "The system did not have the permissions needed to access the KEK.", "The system failed to authenticate with AWS.", "Failed to decrypt the UserIdentifier data using the DEK.", -"The user attempted to ingest events with an ad identifier that isn't from the operating account's ads." +"The user attempted to ingest events with an ad identifier that isn't from the operating account's ads.", +"One-per-click conversion actions cannot be used with BRAIDs." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/gmail.v1.json b/googleapiclient/discovery_cache/documents/gmail.v1.json index 0334fa71f5..0c7cb3db78 100644 --- a/googleapiclient/discovery_cache/documents/gmail.v1.json +++ b/googleapiclient/discovery_cache/documents/gmail.v1.json @@ -3077,7 +3077,7 @@ } } }, -"revision": "20260112", +"revision": "20260413", "rootUrl": "https://gmail.googleapis.com/", "schemas": { "AutoForwarding": { @@ -3729,11 +3729,11 @@ "id": "LabelColor", "properties": { "backgroundColor": { -"description": "The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \\#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \\#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \\#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \\#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \\#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \\#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \\#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \\#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \\#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \\#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \\#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \\#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \\#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765", +"description": "The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \\#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \\#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \\#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \\#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \\#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \\#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \\#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \\#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \\#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \\#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \\#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \\#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \\#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765", "type": "string" }, "textColor": { -"description": "The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \\#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \\#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \\#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \\#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \\#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \\#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \\#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \\#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c \\#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \\#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \\#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \\#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \\#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765", +"description": "The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \\#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \\#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \\#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \\#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \\#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \\#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \\#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \\#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \\#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \\#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \\#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \\#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \\#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/managedkafka.v1.json b/googleapiclient/discovery_cache/documents/managedkafka.v1.json index ed8d8a942d..df5f042e4b 100644 --- a/googleapiclient/discovery_cache/documents/managedkafka.v1.json +++ b/googleapiclient/discovery_cache/documents/managedkafka.v1.json @@ -3186,7 +3186,7 @@ } } }, -"revision": "20260319", +"revision": "20260409", "rootUrl": "https://managedkafka.googleapis.com/", "schemas": { "AccessConfig": { @@ -3510,7 +3510,7 @@ "additionalProperties": { "type": "string" }, -"description": "Optional. Configurations for the worker that are overridden from the defaults. The key of the map is a Kafka Connect worker property name, for example: `exactly.once.source.support`.", +"description": "Optional. Reserved for future use. This field is meant for worker config overrides, but is unsupported for now.", "type": "object" }, "createTime": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json index 43e594b483..f79156d278 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json @@ -530,7 +530,7 @@ } } }, -"revision": "20250615", +"revision": "20260419", "rootUrl": "https://mybusinessaccountmanagement.googleapis.com/", "schemas": { "AcceptInvitationRequest": { @@ -906,7 +906,7 @@ "id": "TargetLocation", "properties": { "address": { -"description": "The address of the location to which the user is invited.", +"description": "The address of the location to which the user is invited. Not always populated.", "type": "string" }, "locationName": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json index d3ae4f2854..ef42b196ad 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json @@ -256,7 +256,7 @@ } } }, -"revision": "20250804", +"revision": "20260415", "rootUrl": "https://mybusinessverifications.googleapis.com/", "schemas": { "AddressVerificationData": { @@ -541,7 +541,6 @@ "PHONE_CALL", "SMS", "AUTO", -"VETTED_PARTNER", "TRUSTED_PARTNER" ], "enumDescriptions": [ @@ -551,7 +550,6 @@ "Make a phone call with a verification PIN to a specific phone number. The PIN is used to complete verification with Google.", "Send an SMS with a verification PIN to a specific phone number. The PIN is used to complete verification with Google.", "Verify the location without additional user action. This option may not be available for all locations.", -"This option may not be available for all locations.", "Verify the location via a trusted partner." ], "type": "string" @@ -608,7 +606,6 @@ "PHONE_CALL", "SMS", "AUTO", -"VETTED_PARTNER", "TRUSTED_PARTNER" ], "enumDescriptions": [ @@ -618,7 +615,6 @@ "Make a phone call with a verification PIN to a specific phone number. The PIN is used to complete verification with Google.", "Send an SMS with a verification PIN to a specific phone number. The PIN is used to complete verification with Google.", "Verify the location without additional user action. This option may not be available for all locations.", -"This option may not be available for all locations.", "Verify the location via a trusted partner." ], "type": "string" @@ -677,7 +673,6 @@ "PHONE_CALL", "SMS", "AUTO", -"VETTED_PARTNER", "TRUSTED_PARTNER" ], "enumDescriptions": [ @@ -687,7 +682,6 @@ "Make a phone call with a verification PIN to a specific phone number. The PIN is used to complete verification with Google.", "Send an SMS with a verification PIN to a specific phone number. The PIN is used to complete verification with Google.", "Verify the location without additional user action. This option may not be available for all locations.", -"This option may not be available for all locations.", "Verify the location via a trusted partner." ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json index c2a122b623..22649e6f6e 100644 --- a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json +++ b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json @@ -167,7 +167,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "oracledatabase.projects.locations.list", @@ -2504,7 +2504,7 @@ } } }, -"revision": "20260402", +"revision": "20260415", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { diff --git a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json index 22688b15cc..a4af214db3 100644 --- a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json +++ b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "saasservicemgmt.projects.locations.list", @@ -1804,7 +1804,7 @@ } } }, -"revision": "20260407", +"revision": "20260415", "rootUrl": "https://saasservicemgmt.googleapis.com/", "schemas": { "Aggregate": { diff --git a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json index bb609a968a..b54c59ef8e 100644 --- a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "saasservicemgmt.projects.locations.list", @@ -2612,7 +2612,7 @@ } } }, -"revision": "20260407", +"revision": "20260415", "rootUrl": "https://saasservicemgmt.googleapis.com/", "schemas": { "Aggregate": { diff --git a/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json b/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json index 8b3ce9b9df..79cfd53cc8 100644 --- a/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json @@ -312,7 +312,7 @@ } } }, -"revision": "20260112", +"revision": "20260420", "rootUrl": "https://smartdevicemanagement.googleapis.com/", "schemas": { "GoogleHomeEnterpriseSdmV1Device": { @@ -320,7 +320,7 @@ "id": "GoogleHomeEnterpriseSdmV1Device", "properties": { "ghpName": { -"description": "Output only. The GHP device ID of the device.", +"description": "Output only. The Home APIs device ID of the device.", "readOnly": true, "type": "string" }, @@ -438,7 +438,7 @@ "type": "string" }, "ghpParent": { -"description": "Output only. The GHP name of the relation -- e.g., structure/room where the device is assigned to. For example: \"homegraph.googleapis.com/Structure/ABC\" or \"homegraph.googleapis.com/Room/ABC\"", +"description": "Output only. The Home APIs name of the relation -- e.g., structure/room where the device is assigned to. For example: \"homegraph.googleapis.com/Structure/ABC\" or \"homegraph.googleapis.com/Room/ABC\"", "readOnly": true, "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json b/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json index 78cb8d160d..e28465e409 100644 --- a/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json +++ b/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json @@ -338,23 +338,23 @@ ], "parameters": { "filter": { -"description": "Optional. Filter criteria.", +"description": "Optional. Filter criteria. Supported fields for filtering include: * `audit.create_time` * `audit.creator` * `audit.update_time` * `audit.updater` * `detail.data_leak.discovery_document_ids` * `detail.data_leak.severity` * `detail.detail_type` * `detail.initial_access_broker.discovery_document_ids` * `detail.initial_access_broker.severity` * `detail.insider_threat.discovery_document_ids` * `detail.insider_threat.severity` * `finding_count` * `priority_analysis.priority_level` * `relevance_analysis.confidence` * `relevance_analysis.relevance_level` * `relevance_analysis.relevant` * `severity_analysis.severity_level` * `state` Examples: * `detail.detail_type = \"initial_access_broker\"` * `detail.detail_type != \"data_leak\"` * `detail.insider_threat.severity = \"HIGH\"` * `audit.create_time >= \"2026-04-03T00:00:00Z\" AND audit.create_time < \"2026-04-06T00:00:00Z\"` * `state = \"NEW\" OR state = \"TRIAGED\"` * `severity_analysis.severity_level = \"SEVERITY_LEVEL_CRITICAL\"`", "location": "query", "type": "string" }, "orderBy": { -"description": "Optional. Order by criteria in the csv format: \"field1,field2 desc\" or \"field1,field2\" or \"field1 asc, field2\".", +"description": "Optional. Order by criteria in the csv format: \"field1, field2 desc\" or \"field1, field2\" or \"field1 asc, field2\". If a field is specified without `asc` or `desc`, ascending order is used by default. Supported fields for ordering are identical to those supported for filtering. Examples: * `audit.create_time desc` * `audit.update_time asc` * `audit.create_time desc, severity_analysis.severity_level desc`", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. Page size.", +"description": "Optional. Page size. Default to 100 alerts per page. Maximum is 1000 alerts per page.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. Page token.", +"description": "Optional. Page token to retrieve the next page of results.", "location": "query", "type": "string" }, @@ -832,7 +832,7 @@ } } }, -"revision": "20260223", +"revision": "20260412", "rootUrl": "https://threatintelligence.googleapis.com/", "schemas": { "Alert": { @@ -1562,7 +1562,7 @@ "type": "array" }, "severity": { -"description": "Required. Data Leak specific severity This will be the string representation of the DataLeakFindingDetail.Severityenum. (e.g., \"LOW\", \"MEDIUM\", \"HIGH\", \"CRITICAL\")", +"description": "Required. The severity of the Data Leak alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL`", "type": "string" } }, @@ -1807,7 +1807,7 @@ "type": "array" }, "severity": { -"description": "Required. IAB specific severity", +"description": "Required. The severity of the Initial Access Broker (IAB) alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL`", "type": "string" } }, @@ -1859,7 +1859,7 @@ "type": "array" }, "severity": { -"description": "Required. InsiderThreat specific severity This will be the string representation of the InsiderThreatFindingDetail.Severityenum. (e.g., \"LOW\", \"MEDIUM\", \"HIGH\", \"CRITICAL\")", +"description": "Required. The severity of the Insider Threat alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL`", "type": "string" } },